1. Payout
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Purchase
        • Overview
        • Pay by card
        • Pay by card: complete 3DS
        • 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
          POST
        • Pay out to IBAN
          POST
        • Get payout balance
          POST
        • Get payout status
          POST
      • 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. Payout

Pay out to IBAN

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/g2g/to_iban
Pays out money in KZT to a bank account in Kazakhstan by IBAN.
Sign the request with the payout secret key: see Sync API Overview.

Result#

pg_statusMeaningNext step
processThe payout is accepted; the bank has not returned the result yet.Wait for the result at pg_post_link, or request Get payout status until it is final.
errorThe request is rejected or the payout is declined. pg_payment_id is not returned.See «Errors» below. To find a declined payout, request Get payout status by pg_order_id.

Payout flow#

Errors#

The HTTP status is always 200; the error is returned in pg_error_code and pg_error_description.
pg_error_codeWhenWhat to do
94031A parameter is missing or has an invalid value. pg_error_description names the parameter.Fix the request.
11005pg_amount is missing, is not a number, or is outside the range 0.01–99999999.Fix the amount.
1100The signature is missing or invalid.Check the signature with the payout secret key.
1824The bank cannot be determined by pg_recipient_iban.Check the IBAN.
1823pg_bank_bik does not match the bank of the IBAN.Fix pg_bank_bik or do not pass it.
1208pg_recipient_iin is not a valid IIN or BIN.Check the IIN or BIN.
10000Payouts through Gateway API are not enabled for the merchant. The response is not signed.Contact Freedom Pay.
8021Payouts by IBAN are not enabled for the merchant.Contact Freedom Pay.
1806The corporate card for payouts is not set up for the merchant.Contact Freedom Pay.
1360Not enough money on the payout balance.Top up the payout balance.
9999The payout could not be performed, or a payout with this pg_order_id already exists: uniqueness of the order ID is enabled for the merchant.Pass a new pg_order_id or repeat the request later.
Other codesThe bank declined the payout.See Error codes.

Request example#

Required fields only. pg_sig is calculated with the payout 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

Example
<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_merchant_id>14035</pg_merchant_id>
    <pg_payment_id>1041</pg_payment_id>
    <pg_status>process</pg_status>
    <pg_order_id>pi-96f346ab</pg_order_id>
    <pg_datetime>2026-10-16T12:52:19+00:00</pg_datetime>
    <pg_salt>tCCSgF9MGwsuTzlf</pg_salt>
    <pg_sig>e6f7f9fd3b20cfe048acf4b5b2fc25ac</pg_sig>
</response>
🟢200Error
Previous
Pay out to card
Next
Get payout balance