Payout notify

POST

https://api.freedompay.kz{{post_link}}

In case of successful payment, the URL specified in pg_post_link will be called

Merchant server should respond with status 200

Post link on the merchant side must be public, without authorization

Request

Header Params

Content-Type

string

optional

Example:

application/x-www-form-urlencoded

Body Params multipart/form-data

pg_payment_id

integer

required

Transaction ID in the system FreedomPay.

pg_order_id

string

optional

Order ID in the merchant system

pg_card_hash

string

optional

Masked PAN card

pg_status

string

optional

The status of the operation. Enum: ok, error.

pg_balance

string

optional

Balance after making a payment.

pg_payment_amount

string

optional

Payout amount.

pg_to_pay

string

optional

Payout amount + commission.

pg_merchant_id

string

required

Merchant ID.

pg_payment_date

string

optional

Payment date.

pg_salt

string

required

A random string consisting of arbitrary numbers and Latin letters. Example: some random string

Example:

some random string

pg_sig

string

required

Request signature.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '{{post_link}}' \
--form 'pg_payment_id=""' \
--form 'pg_order_id="";type=* Order ID in the merchant system.' \
--form 'pg_card_hash="";type=* Masked PAN card.' \
--form 'pg_status="";type=* The status of the operation. Enum: `ok`' \
--form 'pg_balance="";type=* Balance after making a payment.' \
--form 'pg_payment_amount="";type=* Payout amount.' \
--form 'pg_to_pay="";type=* Payout amount + commission.' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_date="";type=* Payment date.' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_status

string

optional

Shows the result of the query.

Example

<?xml version="1.0" encoding="UTF-8"?>
<pg_status>ok</pg_status>

Modified at 2025-04-18 03:54:52

Result notify

Check request