Status - Freedom Pay

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}. Issued upon connection.

pg_payment_id

integer

required

Internal payment identifier in the system FreedomPay if sent along with the pg_order_id field, the pg_order_id field will be ignored.

Example:

12345

pg_order_id

string

optional

Payment ID in the merchant system. Be careful, when requesting by order_id, the merchant must independently monitor the uniqueness of this parameter, otherwise information will be returned for the last payment with the given order_id for this merchant.

Example:

00102

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

required

Shows the result of the query
Status Description
ok — Request was successful,
error — Request was successful

pg_payment_id

integer

required

Unique identifier of the payment transaction in {{project}}; serves as the key for all further work with the transaction.

pg_order_id

string

required

Order ID in the shop system.

pg_currency

string

required

The currency in which the amount is specified.

pg_amount

integer

required

Payment amount.

pg_salt

string

required

Random string.

pg_sig

string

required

Request signature.

pg_can_reject

boolean

optional

Indicates whether the payment can be cancelled (0 or 1). The value 1 is possible only if the payment status is ok and the payment system allows cancellations.

pg_payment_method

string

optional

Payment method
Example: mobile_commerce

pg_payment_status

string

optional

Payment status.

pg_clearing_amount

integer

optional

Amount written off during payment clearing.

pg_revoke_amount

integer

optional

Revoked amount.

pg_user_email

string

optional

Customer's email.

pg_card_name

string

optional

Cardholder name.

pg_card_pan

string

optional

Masked card number.
Example: 5483-18XX-XXXX-0293

pg_card_token

string

optional

The token of a previously saved card. Passed only if the card was successfully saved.

pg_user_phone

string

optional

Customer's phone number.

pg_payment_date

string <date-time>

optional

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

pg_revoked_payments

array[string]

optional

List of revokes for this payment.

pg_refund_payments

array[string]

optional

List of refunds for this payment.

pg_reference

integer

optional

A unique bank transaction identifier assigned by the bank (RRN).

pg_failure_code

integer

optional

Error code.

pg_failure_description

string

optional

Description of the error.

pg_captured

boolean

optional

Indicates whether clearing was performed at the time of authorization. Value is 0 or 1.

pg_auth_code

integer

optional

Bank payment authorization code.

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>123456789</pg_payment_id>
    <pg_can_reject>1</pg_can_reject>
    <pg_payment_method>bankcard</pg_payment_method>
    <pg_amount>10</pg_amount>
    <pg_currency>KZT</pg_currency>
    <pg_payment_status>success</pg_payment_status>
    <pg_clearing_amount>10</pg_clearing_amount>
    <pg_reference>123456789</pg_reference>
    <pg_card_name>Card Holder</pg_card_name>
    <pg_card_pan>5483-18XX-XXXX-0293</pg_card_pan>
    <pg_card_token>ef741cfc-f85e-41a0-84e6-2ba964912182</pg_card_token>
    <pg_refund_payments>
        <pg_refund_payment>
            <pg_payment_id>123456789</pg_payment_id>
            <pg_payment_status>success</pg_payment_status>
            <pg_amount>-10</pg_amount>
            <pg_payment_date>2023-05-31 16:26:36</pg_payment_date>
            <pg_reference>123456789</pg_reference>
        </pg_refund_payment>
    </pg_refund_payments>
    <pg_refund_amount>-10</pg_refund_amount>
    <pg_captured>1</pg_captured>
    <pg_create_date>2023-05-31 16:24:20</pg_create_date>
    <pg_salt>some random string</pg_salt>
    <pg_sig>your_signature</pg_sig>
</response>