Check request - Freedom Pay

To use this request, you should contact your manager

Before accepting money from the buyer on the account, the payment gate can call the merchant script Check URL using the Request Method

Check URL on the merchant side must be public, without authorization

{{project}} sends information about the number and properties of the order and waits for a response. Failure to respond within the specified time is considered as a refusal to pay.

The Check URL script is called only if this option was enabled in the merchant settings

Merchant response to check_url:

ok - payment accepted

rejected - payment refusal

error - error in data interpretation

If Check URL is empty at the moment of payment initialization or not specified at the moment of payment initialization, and is set to empty in the merchant settings, then the step of checking the ability to make a payment is skipped and it is considered that the merchant agrees to accept the payment

Request

Body Params multipart/form-data

pg_order_id

string

required

Order ID in the merchant system.

<= 50 characters

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.

>= 0.01<= 9999999

Example:

pg_currency

string

required

Invoicing currency

<= 3 characters

Example:

KZT

pg_ps_amount

number

required

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

>= 0.01<= 9999999

Example:

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.

<= 3 characters

Example:

KZT

pg_ps_full_amount

number

required

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

>= 0.01<= 99999999

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

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