Freedom Pay

Pay

POST

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

Request

Body Params application/json

pg_merchant_id

integer

required

Merchant ID in the Aggregator system

order_number

string

required

Order number

payment_amount

number <float>

required

Payment amount

commission_amount

number <float>

required

Commission amount

cashback_amount

number <float>

required

Cashback amount

currency

string

required

Payment currency

payment_datetime

string <date-time>

required

Payment date and time

additional

object

required

Additional customer info

iin

string

optional

Individual Identification Number

last_name

string

optional

Customer's last name

first_name

string

optional

Customer's first name

phone_number

string

optional

Phone number

iban

string

optional

International Bank Account Number

order_id

string

optional

Order ID

string

optional

Customer's email

pg_salt

string

required

Random string

pg_sig

string

required

Request signature

Example

{
    "order_number": "ADDKL4DM",
    "merchant_id": "555555",
    "payment_amount": 5000,
    "commission_amount": 11.33,
    "cashback_amount": 55.28,
    "currency": "KZT",
    "payment_datetime": "2025-05-20T17:44:31.693",
    "additional": {
        "iin": "940603300370",
        "last_name": "Ivanov",
        "first_name": "Ivan",
        "phone_number": "77777777777",
        "iban": "KZ505518729251417KZT,10e86a7d-1915-11f0-a0ec-e21ec0a212a0,tous",
        "order_id": "6051c4e3-41d7-4805-bcf7-4e9d398505bb",
        "email": "Ivanov@gmail.com"
    },
    "salt": "iHteyukKiXFfCQ",
    "sig": "bbf37dc8b7bb5a618d634r28ae6bbe5d"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/implement/superapp/pay' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_number": "ADDKL4DM",
    "merchant_id": "555555",
    "payment_amount": 5000,
    "commission_amount": 11.33,
    "cashback_amount": 55.28,
    "currency": "KZT",
    "payment_datetime": "2025-05-20T17:44:31.693",
    "additional": {
        "iin": "940603300370",
        "last_name": "Ivanov",
        "first_name": "Ivan",
        "phone_number": "77777777777",
        "iban": "KZ505518729251417KZT,10e86a7d-1915-11f0-a0ec-e21ec0a212a0,tous",
        "order_id": "6051c4e3-41d7-4805-bcf7-4e9d398505bb",
        "email": "Ivanov@gmail.com"
    },
    "salt": "iHteyukKiXFfCQ",
    "sig": "bbf37dc8b7bb5a618d634r28ae6bbe5d"
}'

Responses

🟢200Success

application/json

Body

message

string

required

Payment description

status

string

required

Payment status

Example

{
    "message": "Payment 1578152613 created successfully",
    "status": "success"
}

Modified at 2025-06-16 15:47:36

Overview

Refund