Status - Freedom Pay

This method is used to get information about the current status of a payment, such as whether it was successful, an error occurred, or is pending

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_payment_id

integer

required

Transaction ID

pg_order_id

string

required

Payment ID in the merchant system

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters

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_payment_id

number

required

Transaction ID

pg_order_id

string

required

Order ID in the shop system

Match pattern:

^[a-zA-Z0-9]+$

pg_currency

string

required

Payment currency. Example: KZT

pg_status

string

required

Request status. Latin characters only.

pg_payment_status

string

optional

Payment status. Latin characters only.

pg_amount

number

required

Amount displayed in the payment

pg_clearing_amount

number

optional

Amount written off during payment clearing

pg_refund_amount

number

optional

Refunded amount

pg_user_email

string <email>

required

Payer's e-mail

pg_card_name

string

optional

Payer's name

pg_card_id

number

optional

Card ID for paying with saved card (Deprecated). Example: 1234

pg_card_token

string

optional

Card token for paying with saved card. Example: ef741cfc-f85e-41a0-84e6-2ba964912182

pg_card_pan

string

optional

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

pg_card_exp

string

optional

Card Expiration Date. Example: 03/23

pg_card_brand

string

optional

Card brand code. Example: VI

pg_user_phone

string

optional

Payer's phone number. Format: 77001234567

pg_payment_date

string <date-time>

required

Payment date. Format: YYYY-MM-DD hh:mm:ss

pg_captured

number

optional

Flag indicating whether the write-off (clearing) of the payment has passed. Values: 0 or 1

pg_refund_payments

array [object {7}]

optional

List of refunds for this payment

pg_payment_id

number

optional

Transaction ID

pg_payment_status

string

optional

Payment status. Latin characters only.

pg_amount

number

optional

Amount set for refund

pg_payment_date

string <date-time>

optional

Payment date. Only successful returns have it. Format: YYYY-MM-DD hh:mm:ss

pg_reference

string

optional

Bank-Assigned Unique Bank Transaction Identifier (RRN)

pg_failure_code

number

optional

Return error code. Available only for returns with the status 'error'.

pg_failure_description

string

optional

Description of the return error. Only returns with status 'error'.

pg_revoked_payments

array [object {2}]

optional

List of revokes for this payment

pg_payment_id

number

optional

Revoke transaction ID

pg_payment_status

string

optional

Revoke payment status. Latin characters only.

pg_reference

string

optional

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

pg_intreference

string

optional

A unique bank transaction identifier assigned by the bank (ARN)

pg_failure_code

number

optional

Return error code. Only available for returns with 'error' status.

pg_failure_description

string

optional

Description of the return error. Available only for returns with the status 'error'.

pg_auth_code

string

optional

Bank payment authorization code. Digits, length 6.

pg_salt

string

required

Random string. Arbitrary numbers and Latin letters.

pg_sig

string

required

Request digital signature. Numbers and Latin letters.

pg_datetime

string <date-time>

required

Date and time of the request. Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Example

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <pg_payment_id>1427057029</pg_payment_id>
  <pg_order_id>2343253465454</pg_order_id>
  <pg_currency>KZT</pg_currency>
  <pg_status>ok</pg_status>
  <pg_payment_status>success</pg_payment_status>
  <pg_amount>1030</pg_amount>
  <pg_clearing_amount>0</pg_clearing_amount>
  <pg_refund_amount>0</pg_refund_amount>
  <pg_user_email></pg_user_email>
  <pg_card_name>NAME NAME</pg_card_name>
  <pg_user_phone></pg_user_phone>
  <pg_payment_date>2024-11-28 15:44:53</pg_payment_date>
  <pg_card_pan>4400-44XX-XXXX-4444</pg_card_pan>
  <pg_card_exp>12/24</pg_card_exp>
  <pg_card_brand>string</pg_card_brand>
  <pg_net_amount>1005.28</pg_net_amount>
  <pg_reference>4333333333</pg_reference>
  <pg_captured>0</pg_captured>
  <pg_auth_code>932495</pg_auth_code>
  <pg_intreference>TE5XTR4GGFF</pg_intreference>
  <pg_salt>XeFNeRYiwcqlWPg9TZUj6pc9gj6KYBSb</pg_salt>
  <pg_sig>d333fb3333b3f6e861c61682ba173c46</pg_sig>
  <pg_datetime>2024-11-28T10:44:55+00:00</pg_datetime>
</response>

🟢200Error