Pay out to IBAN

Pays out money in KZT to a bank account in Kazakhstan by IBAN.

Sign the request with the payout secret key: see Merchant API Overview.

Payout flow

Result

`pg_status`	Meaning	Next step
`process`	The 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.
`error`	The 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`.

Errors

The HTTP status is always 200; the error is returned in pg_error_code and pg_error_description.

`pg_error_code`	When	What to do
`94031`	A parameter is missing or has an invalid value. `pg_error_description` names the parameter.	Fix the request.
`11005`	`pg_amount` is missing, is not a number, or is outside the range 0.01–99999999.	Fix the amount.
`1100`	The signature is missing or invalid.	Check the signature with the payout secret key.
`1824`	The bank cannot be determined by `pg_recipient_iban`.	Check the IBAN.
`1823`	`pg_bank_bik` does not match the bank of the IBAN.	Fix `pg_bank_bik` or do not pass it.
`1208`	`pg_recipient_iin` is not a valid IIN or BIN.	Check the IIN or BIN.
`8021`	Payouts by IBAN are not enabled for the merchant.	Contact Freedom Pay.
`1806`	The corporate card for payouts is not set up for the merchant.	Contact Freedom Pay.
`1360`	Not enough money on the payout balance.	Top up the payout balance.
`9999`	The 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 codes	The 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.

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>4114</pg_payment_id>
    <pg_status>process</pg_status>
    <pg_order_id>mi-30a8af34</pg_order_id>
    <pg_salt>R0Y8kwQHMg8qWXmy</pg_salt>
    <pg_sig>02382a7ce2e66afe8a78e090a1d9d26a</pg_sig>
</response>

🟢200Error

Payout flow#

Result#

Errors#

Request example#

Request

Responses

Payout flow

Result

Errors

Request example