Clearing

POST

https://api.freedompay.kz/g2g/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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/g2g/clearing' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id=""' \
--form 'pg_clearing_amount=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

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

Modified at 2025-04-18 11:13:27

Cancel

Refund

Clearing

Interaction diagram#

Request

Request Code Samples

Responses

Interaction diagram