Freedom Pay

Balance status

POST

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

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

Interaction diagram

Status: success/error/pending

Merchant_API_V3-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

optional

Balance currency

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/api/balance_status' \
--form 'pg_merchant_id=""' \
--form 'pg_currency=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_balance

number

required

Balance.

pg_status

string

required

Request Status.

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters.

pg_sig

string

required

Request signature.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_balance>0</pg_balance>
  <pg_status>string</pg_status>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>

Modified at 2025-03-24 12:37:49

IBAN

Status by order_id

Balance status

Interaction diagram#

Request

Request samples

Responses

Interaction diagram