Status by order_id - Freedom Pay

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant identifier in FreedomPay. Issued during registration.

pg_order_id

string

required

Payment identifier in the merchant's system. Note: Ensure the uniqueness of this parameter

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

🟢200OK

application/xml

Body

pg_status

string

required

Indicates the result of the request:

ok — Request was successful.

error — Request encountered an error.

pg_payment_id

integer

required

Unique identifier for the payment transaction in FreedomPay. Serves as the key for further work with the transaction.
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_transaction_status

string

required

Payment status:

partial — New payment.

pending — Awaiting payer or payment system action.

ok — Payment successfully completed.

failed — Payment encountered an error.

incomplete — Payment lifetime expired.

pg_can_reject

enum<integer>

required

Indicates whether the payment can be rejected. Enum: 0 | 1.

Allowed values:

pg_testing_mode

enum<integer>

optional

Indicates whether the payment is in test mode.

0 — Payment is in production mode.

1 — Payment is in test mode.

Allowed values:

pg_captured

enum<integer>

required

Indicates whether the payment has been captured. Enum: 0 | 1.

Allowed values:

pg_create_date

string <date-time>

required

Date and time of the payment transaction creation.

pg_salt

string

required

Random string.

pg_sig

string

required

Request signature.

pg_failure_code

string

optional

Error code.

pg_failure_description

string

optional

Error description.

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>511194</pg_payment_id>
    <pg_transaction_status>ok</pg_transaction_status>
    <pg_can_reject>0</pg_can_reject>
    <pg_captured>1</pg_captured>
    <pg_create_date>2021-08-26 11:52:25</pg_create_date>
    <pg_salt>41F5ZyqcOabTG5u7</pg_salt>
    <pg_sig>34484775bd62986753429d6af57e94eb</pg_sig>
</response>

🟢200Failed

🟢200Partial

🟢200Pending