1. Payouts
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
      • Payouts
        • Overview
        • Pay out to card
        • Pay out to IBAN
        • Get payout balance
        • Get payout status
      • Transfers
        • 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)
        • Cancel payment (reverse)
        • Refund payment
  • Merchant API
    • Overview
    • Payments
      • Overview
      • Checkout
      • Pay by saved card
        • Overview
        • Create payment
        • Confirm payment with CVC
        • Confirm payment without the client
      • Create payment
      • Create payment with a payment page template
      • Create payment in a payment frame
      • Create payment with any amount
      • Create recurring payment
      • Capture payment (clearing)
      • Cancel payment
      • Refund payment
      • Get payment status
    • Payouts
      • Overview
      • Create payout page
        POST
      • Pay out to saved card
        POST
      • Pay out to IBAN
        POST
      • Get payout status
        POST
      • Get payout balance
        POST
    • 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
    • Saved cards
      • Get saved cards
      • Save card
      • Save card for payouts
      • Delete saved card
      • Save card without a charge
    • 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. Payouts

Pay out to saved card

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/api/reg2reg
Pays out money to a saved card by its token.
Save the card first: Save card for payouts or Save card. Pass the token in pg_card_token_to together with the same pg_user_id.
Sign the request with the payout secret key: see Merchant API Overview.

Payout flow#

The final result of the payout, successful or declined, is also sent to pg_post_link.

Result#

pg_statusMeaningNext step
okThe payout is made.Nothing else is needed.
processThe payment system 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.See «Errors» below. To find a declined payout, request Get payout status by pg_order_id.

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. The response is not signed.Fix the request.
11005pg_amount is missing, is not a number, or is outside the range 0.01–99999999. The response is not signed.Fix the amount.
1100The signature is missing or invalid, or pg_merchant_id is not found. The response is not signed.Check the merchant ID and the signature with the payout secret key.
1804The card is not found by pg_card_token_to and pg_user_id.Check the token and pass the pg_user_id the card was saved for.
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: see Get payout balance.
10000Payouts to cards are not enabled for the merchant, or the payout could not be performed.Contact Freedom Pay or repeat the request later.
Other codesThe payment system 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_status>ok</pg_status>
    <pg_merchant_id>13991</pg_merchant_id>
    <pg_payment_id>4112</pg_payment_id>
    <pg_order_id>mt-81631bba</pg_order_id>
    <pg_balance></pg_balance>
    <pg_payment_date>2026-10-25 22:48:59</pg_payment_date>
    <pg_payment_amount>100</pg_payment_amount>
    <pg_card_id>326</pg_card_id>
    <pg_card_token>ebe6d18b-5c30-42d7-88cc-3c1d189b4b0f</pg_card_token>
    <pg_card_hash>4671-59XX-XXXX-8252</pg_card_hash>
    <pg_reference></pg_reference>
    <pg_salt>rN8opn3t3Lb0VsfH</pg_salt>
    <pg_sig>a7dd00c20ae645f170a1b057b456f65a</pg_sig>
</response>
🟢200Error
Previous
Create payout page
Next
Pay out to IBAN