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

optional

Transaction ID

pg_order_id

string

required

Payment ID in the merchant system

pg_salt

string

required

Random string consisting of arbitrary digits and Latin characters

pg_sig

string

required

Request signature

pg_currency

string

optional

Currency of the payment

pg_amount

number <float>

optional

Payment amount

pg_card_name

string

optional

Cardholder's name

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kz/api/payment_status2' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id=""' \
--form 'pg_order_id="";type=* Order ID in the seller's system. Maximum length is 50 characters.' \
--form 'pg_salt=""' \
--form 'pg_sig=""' \
--form 'pg_currency=""' \
--form 'pg_amount=""' \
--form 'pg_card_name=""'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

ID of the transaction in the FreedomPay system.
If in response to the payment status check you receive payment_id = 0 within a minute, then the payment does not exist in our system.

pg_merchant_id

integer

required

Merchant ID in the FreedomPay system.

pg_status

string

required

Status of the request.

pg_payment_status

enum<string>

required

Transaction status:

success: Transaction completed successfully.

error: Transaction failed.

process: Used when the bank responded incorrectly, and we finalized the transfer status on our side.

Allowed values:

successerrorprocess

pg_order_id

integer

required

Order ID in the seller's system. Maximum length is 50 characters.

pg_currency

string

required

Currency of the payment

pg_amount

number

required

Payment amount

pg_card_name

string

required

Cardholder's name

pg_salt

string

required

Random string consisting of arbitrary digits and Latin characters.

pg_sig

string

required

Signature.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_payment_id>0</pg_payment_id>
  <pg_merchant_id>0</pg_merchant_id>
  <pg_status>string</pg_status>
  <pg_payment_status>success</pg_payment_status>
  <pg_order_id>0</pg_order_id>
  <pg_currency>string</pg_currency>
  <pg_amount>0</pg_amount>
  <pg_card_name>string</pg_card_name>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>