read payment

POST

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

Request

Header Params

Body Params application/json

Example

{
    "id": "01907dac-a93d-776e-b475-cba6a54a4888",
    "order_id": "1234"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/g2g/read' \
--header 'Accept;' \
--header 'X-JWS-Signature;' \
--header 'X-Action;' \
--header 'X-Request-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "01907dac-a93d-776e-b475-cba6a54a4888",
    "order_id": "1234"
}'

Responses

🟢200OK

application/json

Headers

Body

Since the API operates asynchronously, whenever the payment status is returned as process, you must continuously query the payment status until you receive a final status such as approved or success.

{
    "id": "01978d0e-b956-7ea2-9a42-32cff1f44ede",
    "status": "approved",
    "amount": 100,
    "created_at": "2025-06-20T07:13:31.068188524Z",
    "order_id": "1234",
    "clearing": {
        "cleared": false,
        "amount": 0
    },
    "from": {
        "card": {
            "token": "01978d11-669e-7dd1-bf1b-75a12bf57ca9",
            "brand": "VI"
        }
    },
    "additional": {
        "approval_code": "95F69T",
        "reference": "1234567891234",
        "intreference": "AC1BFED11052BFAC"
    },
    "3ds": {
        "acs_url": "",
        "flow_type": "F"
    }
}

Modified at 2025-09-23 11:37:12

create payment

read request