1. Edit
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Payments
        • Overview
        • Pay by card
        • Pay by card: complete 3DS
        • Pay with Apple Pay
        • Pay with Google Pay
        • Pay by recurring profile
        • Create payment page
        • Create payment page with any amount
        • Capture payment (clearing)
        • Cancel payment
        • Refund payment
        • Get payment status
      • Payout
        • Overview
        • Pay out to card
        • Pay out to IBAN
        • Get payout balance
        • Get payout status
      • Transfer
        • Overview
        • Transfer from card to card
        • Transfer from card to card: complete 3DS
        • Get exchange rates
        • Get transfer status
      • Saved cards
        • Overview
        • Save card
        • Save card: complete 3DS
        • List saved cards
        • Remove saved card
        • Pay by card token
        • Pay out to card token
        • Get payment status
    • Async API
      • Overview
      • Create
        • Create payment
      • Read
        • Get payment status
        • Get request result
      • Edit
        • Capture payment (clearing)
          POST
        • Cancel payment (reverse)
          POST
        • Refund payment
          POST
  • 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. Edit

Capture payment (clearing)

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/v5/g2g/edit
Debits funds held by a two-step payment (auto_clearing = false).
The X-Action header must be gateway.payment.clearing.
Sign the request with X-JWS-Signature: see Async API Overview.
Clearing is possible once, only for a payment in status approved.
Without amount the full payment amount is debited. With a smaller amount the rest is reversed automatically: it is listed in reverse_payments.
A one-step payment (auto_clearing = true) is debited at creation: to return the money use gateway.payment.refund.

Two-step payment flow#

Result#

ResponseMeaningNext step
status = process_clearingThe clearing is accepted.Get the final status with gateway.payment.status: the payment gets status success, clearing.cleared = true. If the response is lost, use gateway.request.status.
{}, X-Request-Status: processThe result is not ready yet.Repeat the request in a few seconds with the same X-Request-Id.

Errors#

A rejected clearing is returned with HTTP 400, status error and the error object.
The error is returned in error.code and error.description.
HTTPerror.codeWhenWhat to do
400110691Invalid payment status: clearing is possible only for a two-step payment in status approved (not cleared, not reversed, not waiting for 3DS).Get the payment status with gateway.payment.status.
400110741The clearing amount exceeds the payment amount.Pass amount not greater than the payment amount.
4009400The body is not valid JSON.Fix the request.
4019998The signature is invalid.Check the signature: see Async API Overview.
4229403id is missing or is not a UUID, amount is less than 0.01, or a required header is missing. The reason is in error.description.Fix the request.
5009999Internal error at the gateway entry point.Repeat the request later with the same X-Request-Id.
50010000Internal error in payment processing.Repeat the request later with the same X-Request-Id.

Request

Header Params

Body Params application/json

Examples
{
  "id": "01a133af-20c6-75d2-8c07-2bef4dc95212"
}

Responses

🟢200OK
application/json
Headers

Bodyapplication/json

Examples
{
  "id": "01a133af-20c6-75d2-8c07-2bef4dc95212",
  "status": "process_clearing",
  "amount": 100,
  "created_at": "2026-10-13T05:14:37.638388726Z",
  "clearing": {
    "amount": 40
  }
}
🟠400Bad Request
🟠422Unprocessable Entity
🟠401Unauthorized
🔴500Internal Server Error
Previous
Get request result
Next
Cancel payment (reverse)