Clearing - Freedom Pay

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

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

>= 0.01<= 99999999

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_amount

number

required

Payment amount.

pg_clearing_amount

number

optional

Clearing amount. If not specified, the refund will be the full amount.

pg_status

string

required

Shows the result of the query. ok if the request is accepted for processing.
error otherwise.

pg_error_description

string

optional

The description of the error in the case of pg_status is error.

pg_salt

string

required

Random string.

pg_sig

string

required

Request signature.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_amount>0</pg_amount>
  <pg_clearing_amount>0</pg_clearing_amount>
  <pg_status>string</pg_status>
  <pg_error_description>string</pg_error_description>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>