Freedom Pay

Check request

POST

https://api.freedompay.uz{{check_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 system {{project}}.

Example:

12345

pg_amount

number

required

The amount of the invoice (in pg_currency) is the same as pg_amount at the time of payment initialization.

Example:

pg_currency

string

required

Invoicing currency

Example:

KZT

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_ps_amount

number

required

The amount of the invoice (in pg_ps_currency currency) issued in the payment system.

Example:

pg_ps_full_amount

number

required

The total amount (in pg_ps_currency currency) that the buyer will pay including all fees.

Example:

Merchant parameters

string

optional

All fields passed from the merchant website that do not have the pg_ prefix.

pg_salt

string

required

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 '{{check_url}}' \
--form 'pg_order_id="123456789";type=false' \
--form 'pg_payment_id="12345";type=false' \
--form 'pg_amount="10";type=false' \
--form 'pg_currency="KZT";type=false' \
--form 'pg_ps_currency="KZT";type=false' \
--form 'pg_ps_amount="5";type=false' \
--form 'pg_ps_full_amount="5";type=false' \
--form 'Merchant parameters="";type=false' \
--form 'pg_salt="some random string";type=false' \
--form 'pg_sig="";type=false'

Responses

🟢200Success

application/xml

Body

pg_status

string

optional

If the merchant confirms the readiness of the order and the correctness of the amount, he must respond in the form of XML with the status ok.

In case of refusal to pay rejected.

error - error in data interpretation.

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>Платеж разрешен</pg_description>
    <pg_salt>random string</pg_salt>
    <pg_sig>ksdjrimzjedkljsujjemnjsuj</pg_sig>
</response>

🟢200Rejected

🟢200Error

Introduction

Result notify