Freedom Pay

Balance

POST

https://api.freedompay.kz/g2g/balance_status

This method allows retrieving information about the current state of the payout balance

Interaction diagram

Status: success/error/pending

G2G_API_V3-Get payout balance.drawio.png

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_currency

string

required

Balance currency
See section Currencies directory

pg_salt

string

required

A random string consisting of arbitrary numbers and Latin letters

pg_sig

string

required

Request signature

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/g2g/balance_status' \
--form 'pg_merchant_id=""' \
--form 'pg_currency=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_balance

number

required

pg_status

string

required

pg_currency

string

required

pg_salt

string

required

pg_sig

string

required

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_balance>150000.50</pg_balance>
    <pg_status>ok</pg_status>
    <pg_currency>KZT</pg_currency>
    <pg_salt>some random string</pg_salt>
    <pg_sig>signature-abc123</pg_sig>
</response>

Modified at 2025-04-18 11:22:16

IBAN

Status

Balance

Interaction diagram#

Request

Request samples

Responses

Interaction diagram