Clearing

This method involves sending a request to withdraw the payment amount that was previously held on the payer's card

If Freedom Pay Gateway does not receive a clearing or cancellation request within 5 days, the payment will be automatically cleared

The method is available only for two-step payments

Interaction diagram

Status: success/error/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_clearing_amount

number

optional

The partial clearing amount should be less than the payment amount

pg_salt

string

required

A 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

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

Interaction diagram#

Request

Request samples

Responses

Interaction diagram