Freedom Pay

edit payment.clearing

POST

https://api.freedompay.kz/v5/g2g/edit

Request

Header Params

string

required

Indicates the media types that the client is able to understand from the server response.

Example:

application/json

Content-Type

string

required

Specifies the media type of the resource being sent to the server.

Example:

application/json

X-Action

string

required

Invoked method.

Default:

gateway.payment.clearing

X-Request-Id

string <uuid>

required

Unique request ID (UUID).
If the same request_id is sent more than once, the API guarantees idempotent behavior and returns the original response.

Example:

01978c2b-f191-7b56-92f8-20c7c401d1fc

X-JWS-Signature

string

required

Request signature.

Example:

eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1NiJ9.eyJpc3MiOiJleGFtcGxlLmNvbSIsInN1YiI6InVzZXIxMjMiLCJhdWQiOiJhcGkuZXhhbXBsZS5jb20iLCJleHAiOjE2MzAwMDAwMDAsImlhdCI6MTYyOTk5NjQwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Body Params application/json

string <uuid>

required

Payment ID (UUID).

Example:

01978d27-fdb1-7fd1-8812-ce7a83414c72

amount

number <float>

required

Clearing amount.

Example:

100

Example

{
    "id": "019052f1-e8dd-7de5-b09c-787d09f53891",
    "amount": 100
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/g2g/edit' \
--header 'Accept: application/json' \
--header 'X-Action;' \
--header 'X-Request-Id: 01978c2b-f191-7b56-92f8-20c7c401d1fc' \
--header 'X-JWS-Signature: eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1NiJ9.eyJpc3MiOiJleGFtcGxlLmNvbSIsInN1YiI6InVzZXIxMjMiLCJhdWQiOiJhcGkuZXhhbXBsZS5jb20iLCJleHAiOjE2MzAwMDAwMDAsImlhdCI6MTYyOTk5NjQwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "019052f1-e8dd-7de5-b09c-787d09f53891",
    "amount": 100
}'

Responses

🟢200Success

application/json

Headers

x-request-id

string

required

Request ID (UUID), equals X-Request-Id from request headers.

Example:

01978c2b-f191-7b56-92f8-20c7c401d1fc

x-request-status

string

required

Request status.

Example:

success

x-datetime

string

required

Request datetime.

Example:

2025-06-20T07:13:31Z

Body

string

required

status

string

required

amount

integer

required

created_at

string

required

clearing

object

required

amount

integer

required

Example

{
    "id": "01976974-b5ec-7e89-bb88-5ba118385e88",
    "status": "process_clearing",
    "amount": 100,
    "created_at": "2025-06-13T13:22:25.900953117Z",
    "clearing": {
        "amount": 0
    }
}

Modified at 2025-06-26 13:33:38

edit payment.reverse

Overview