1. Purchase
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Purchase
        • Overview
        • Create payment
          POST
        • Any amount
          POST
        • Pay by card
          POST
        • Pay by card: complete 3DS
          POST
        • Pay by recurring profile
          POST
        • Cancel payment
          POST
        • Capture payment (clearing)
          POST
        • Refund payment
          POST
        • Get payment status
          POST
      • Payout
        • Overview
        • Card
        • IBAN
        • Balance
        • Status
      • Transfer
        • Overview
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Overview
        • Add
        • 3DSecure
        • List
        • Remove
        • Get payment status
      • Token
        • Overview
        • Token Pay
        • Apple Pay
        • Google Pay
        • Token Payout
        • Get payment status
    • Async API
      • Overview
      • Create
        • Create payment
      • Read
        • Get payment status
        • Get request result
      • Edit
        • Capture payment (clearing)
        • Cancel payment (reverse)
        • Refund payment
  • Merchant API
    • Overview
    • Purchase
      • Overview
      • Checkout
      • Card token
        • Overview
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment (with CVC)
        • Confirm payment (with CVC)
        • Create payment
        • Confirm payment
      • Create payment
      • Any amount
      • Reccuring payment
      • Cancel payment
      • Clearing
      • Refund payment
      • Status
    • Payout
      • Overview
      • Card token
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment
      • Create payment
      • IBAN
      • Balance status
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Recurring profile
        • Overview
        • Create
        • Cancel
        • Info
        • Notify
      • Tips
        • Overview
        • Create
      • Create
      • Execute
      • Info
      • Refund
      • Status
      • Cancel
    • SDK
      • JS SDK
      • Merchant SDK
        • Google Pay
        • Android
        • IOS
    • CMS
      • Overview
      • Get Merchant ID and key
      • WordPress
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
        • Update
      • Tilda
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • InSales
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Ecwid
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Bitrix
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • PrestaShop
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • OpenCart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Installment
      • Overview
      • Status
        • Application Status
        • Application Callback Status
        • Application Change Status
      • Get partners
      • Create application
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Client request status
      • Create terminal
      • Update terminal limits
      • Product request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
      • Status
    • Account
      • Overview
      • Create payment
      • Payment status
      • Batch statuses
      • Statement
      • Statement status
      • Balance
      • Balance status
    • Invoices
      • Info
  1. Purchase

Capture payment (clearing)

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/g2g/clearing
Captures the amount of a two-step payment (pg_auto_clearing = 0) that was blocked at authorization, and returns the result in the same response.
One clearing per payment: capture the full amount or a part of it; the rest of the amount is not debited.
If neither clearing nor cancel is requested within 5 days (the period can be changed for the merchant), the payment is captured or cancelled automatically, depending on the merchant settings. Test payments are not processed automatically.
Test cards: see Gateway API Overview.

Result#

pg_statusMeaningNext step
okThe amount is captured: see pg_clearing_amount.To return the money, call refund.
pendingThe payment system has not returned the result yet.Request the status with status_v2 until it is final.
errorThe request is rejected or the payment system declined the clearing.See «Errors» below.

Clearing flow#

pg_clearing_amount in the request is optional: without it the full payment amount is captured.

Errors#

The HTTP status is always 200; the error is returned in pg_error_code and pg_error_description.
pg_error_codeWhenWhat to do
9403A parameter is missing or has an invalid value (for example pg_clearing_amount is less than 0.01 or not a number), or a payment with this pg_payment_id does not exist.Fix the request.
1100The signature is missing or invalid.Check the signature: see Sync API Overview.
1101pg_merchant_id is not found. The response is not signed.Check the merchant ID.
1202The payment belongs to another merchant or is not a card payment.Check pg_payment_id and pg_merchant_id.
110741pg_clearing_amount is greater than the payment amount. The payment is not captured.Repeat the request with a correct amount.
100361The amount has already been captured: the clearing was done before, or the payment is one-step.Do not repeat the call. To return the money, call refund.
11090The payment has been cancelled.The payment cannot be captured; create a new payment if needed.
100351The payment is not successful, for example 3DS authentication is not completed.Complete the payment first.
10000The clearing could not be performed.Repeat the request later.
Other codesThe payment system declined the clearing, or the payment was declined earlier: its error is returned.See Error codes.

Request example#

Required fields only. pg_sig is calculated with the secret key test_secret_key.
Line breaks in the body are added for readability: send the body as one line.

Request

Body Params multipart/form-data

Responses

🟢200Success
application/xml
Bodyapplication/xml

Examples
<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>1015054203192</pg_payment_id>
    <pg_amount>100</pg_amount>
    <pg_clearing_amount>100</pg_clearing_amount>
    <pg_status>ok</pg_status>
    <pg_status_clearing>1</pg_status_clearing>
    <pg_datetime>2026-10-15T10:41:05+00:00</pg_datetime>
    <pg_salt>uYh8PnhyGiUBGv7q</pg_salt>
    <pg_sig>21836b3d45bf02a71483b9894a00699a</pg_sig>
</response>
🟢200Error
Previous
Cancel payment
Next
Refund payment