Get payout balance

Returns the payout balance of the merchant.

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

Request flow

Result

`pg_status`	Meaning	Next step
`ok`	The balance is returned in `pg_balance`.	Nothing else is needed.
`error`	The request is rejected.	See «Errors» below.

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`	`pg_currency` has an invalid value. The response is not signed.	Fix the request.
`1100`	The 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.
`10000`	Payouts are not enabled for the merchant.	Contact Freedom Pay.

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_balance>0</pg_balance>
    <pg_status>ok</pg_status>
    <pg_currency>KZT</pg_currency>
    <pg_salt>wRNYZDVG6U</pg_salt>
    <pg_sig>f5cedb020be530e2626795642aeefd8b</pg_sig>
</response>

🟢200Error

Request flow#

Result#

Errors#

Request example#

Request

Responses

Request flow

Result

Errors

Request example