Freedom Pay

Result notify

POST

https://api.freedompay.uz{{result_url}}

Request

Body Params multipart/form-data

pg_order_id

string

required

Order ID in the merchant system.

Example:

123456789

pg_payment_id

integer

required

Internal payment identifier in the FreedomPay system.

Example:

12345

pg_amount

string

required

Amount of invoice in pg_currency currency.

Example:

500

pg_currency

string

required

Currency of the invoice

Example:

KZT

pg_net_amount

string

required

Amount of invoice (in pg_ps_currency)

Example:

482.5

pg_ps_amount

string

required

Total amount (in pg_ps_currency currency)

Example:

500

pg_ps_full_amount

string

required

Full amount (in pg_ps_currency currency)

Example:

500

pg_ps_currency

string

required

The currency in which the payment was made in the payment system. The field may be absent in case of unsuccessful payment.

Example:

KZT

pg_description

string

required

Payment description.

Example:

Purchase in the online store Site.kz

pg_result

integer

required

Payment result. 2 - Not completed. 1 - success, 0 - failure.

Example:

pg_payment_date

string

required

Date and time of the payment in YYYY-MM-DD HH:MM:SS format.

Example:

2019-01-01 12:00:00

pg_can_reject

integer

optional

Indicates if the payment can be rolled back: 1 – Payment can be rolled back

Example:

pg_user_phone

string

optional

Customer phone number (specified during payment initialization).

Example:

7077777777777

pg_user_contact_email

string

optional

Customer's email (specified during payment initialization).

Example:

mail@customer.kz

pg_testing_mode

integer

optional

Testing mode: 1 - Test

Example:

pg_captured

integer

optional

Indicates whether clearing was performed at the time of authorization for bank card payments.

Example:

pg_card_id

string

optional

Optional parameter: Card ID for paying with saved card (Deprecated).

Example:

1234

pg_card_token

string

optional

Optional parameter: Card token for paying with saved card.

Example:

ef741cfc-f85e-41a0-84e6-2ba964912182

pg_card_pan

string

optional

Masked card number (part of the digits of the card number are hidden).

Example:

5483-18XX-XXXX-0293

Merchant parameters

string

optional

All fields passed from the merchant's website that do not have the pg_

pg_salt

string

required

Random string.

Example:

some random string

pg_sig

string

required

Request signature.

pg_discount_percent

string

optional

Discount percentage information (sent if there is a discount).

Example:

1.0

pg_discount_amount

string

optional

Discount amount information (sent if there is a discount).

Example:

pg_payment_method

string

optional

Payment method: wallet

Example:

bankcard

pg_card_exp

string

optional

Card expiration date.

Example:

03/23

pg_card_owner

string

optional

Cardholder name.

Example:

Ivan Ivanov

pg_card_brand

string

optional

Card brand code.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '{{result_url}}' \
--form 'pg_order_id="123456789"' \
--form 'pg_payment_id="12345"' \
--form 'pg_amount="500"' \
--form 'pg_currency="KZT"' \
--form 'pg_net_amount="482.5"' \
--form 'pg_ps_amount="500"' \
--form 'pg_ps_full_amount="500"' \
--form 'pg_ps_currency="KZT"' \
--form 'pg_description="Purchase in the online store Site.kz"' \
--form 'pg_result="1"' \
--form 'pg_payment_date="2019-01-01 12:00:00"' \
--form 'pg_can_reject="1"' \
--form 'pg_user_phone="7077777777777"' \
--form 'pg_user_contact_email="mail@customer.kz"' \
--form 'pg_testing_mode="1"' \
--form 'pg_captured="0"' \
--form 'pg_card_id="1234"' \
--form 'pg_card_token="ef741cfc-f85e-41a0-84e6-2ba964912182"' \
--form 'pg_card_pan="5483-18XX-XXXX-0293"' \
--form 'Merchant parameters="";type=* All fields passed from the merchant's website that do not have the pg_ prefix.' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""' \
--form 'pg_discount_percent="1.0"' \
--form 'pg_discount_amount="5"' \
--form 'pg_payment_method="bankcard"' \
--form 'pg_card_exp="03/23"' \
--form 'pg_card_owner="Ivan Ivanov"' \
--form 'pg_card_brand="VI"'

Responses

🟢200Success

application/xml

Body

pg_status

string

optional

pg_description

string

optional

pg_salt

string

optional

pg_sig

string

optional

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_description>Order paid</pg_description>
    <pg_salt>random string</pg_salt>
    <pg_sig>ksdjrimzjedkljsujjemnjsuj</pg_sig>
</response>

🟢200Canceled

Check request

Payout notify