Freedom Pay

Refund

Developing

POST

https://api.freedompay.kzhttps://api.freedompay.kz/implement/superapp/refund

Request

Body Params application/json

pg_merchant_id

integer

required

Merchant ID in the Aggregator system

pg_order_id

string

required

Order number in the merchant’s system

pg_refund_amount

number <float>

required

Refund amount

pg_salt

string

required

Random string

pg_sig

string

required

Request signature

Example

{
    "pg_merchant_id": "111111",
    "pg_order_id": "c8449bc8-be15-47a3-ab4c-47bda6ecefg3",
    "pg_refund_amount": "5000",
    "pg_salt": "iHteyukKiXFfCQ",
    "pg_sig": "60a18b47c21464d54696d174564c45d1"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/implement/superapp/refund' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pg_merchant_id": "111111",
    "pg_order_id": "c8449bc8-be15-47a3-ab4c-47bda6ecefg3",
    "pg_refund_amount": "5000",
    "pg_salt": "iHteyukKiXFfCQ",
    "pg_sig": "60a18b47c21464d54696d174564c45d1"
}'

Responses

🟢200Success

application/json

Body

pg_merchant_id

integer

required

Merchant ID

pg_payment_id

string <uuid>

required

Refund ID in the Aggregator system

pg_order_id

string

required

Order ID

pg_status

string

required

Request status

pg_error_code

integer

required

0 if success, error code if failure

pg_error_description

string

required

Empty if success, error description if failure

refund_timestamp

string <date-time>

required

Refund date (matches the refund creation time)

pg_salt

string

required

Random string

pg_sig

string

required

Response signature

Examples

SuccessError

{
    "pg_merchant_id": 553226,
    "pg_order_id": "6051c4e3-41d7-4805-bcf7-4e9d398505bb",
    "pg_salt": "q1Qzigl6fMb09X5Y",
    "pg_status": "success",
    "pg_error_code": 0,
    "pg_error_description": "",
    "pg_payment_id": 1539715642,
    "refund_timestamp": "2025-04-09T09:07:39.000000Z",
    "pg_sig": "460f6546df4aafcc118ff53575c31a2c"
}

Modified at 2025-06-16 15:33:39

Pay