Clearing - Freedom Pay

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID.
Numbers.||integer

Example:

pg_payment_id

integer

required

Transaction ID.
Numbers.||integer

pg_salt

string

required

Random string. Arbitrary numbers and letter.

pg_sig

string

required

Digital signature of the request. Numbers and Latin letters

Example:

pg_clearing_amount

number

optional

The partial clearing amount should be less than the payment amount.||number

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.kg/g2g/clearing' \
--form 'pg_merchant_id="{{paybox_merchant_id}}"' \
--form 'pg_payment_id=""' \
--form 'pg_salt=""' \
--form 'pg_sig="{{paybox_signature}}"' \
--form 'pg_clearing_amount=""'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

Transaction ID.

pg_amount

integer

required

Total amount.

pg_clearing_amount

integer

required

The partial clearing amount should be less than the payment amount.

pg_status

string

required

Request status

pg_clearing_status

string

required

Clearing status.
1 - Clearing completed, 0 - Clearing not completed

pg_salt

string

required

Random string.
Arbitrary digits and Latin letters

pg_sig

string

required

Digital signature of the request.

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>7777777777</pg_payment_id>
    <pg_amount>1000</pg_amount>
    <pg_clearing_amount>500</pg_clearing_amount>
    <pg_status>ok</pg_status>
    <pg_status_clearing>1</pg_status_clearing>
    <pg_salt>YtfwCGiBHsFLpYGk</pg_salt>
    <pg_sig>ccee466c01c2332d8a065d6108fd686b</pg_sig>
</response>

🟢200Error

🟢200Invalid Signature