API REFERENCE

Query balance

YabandPay documentation·Updated Oct 26, 2026

This API queries the YabandPay wallet balance.

Tip

Only merchant super administrator accounts can call this API. Operator and cashier accounts are not authorized to call it.

Parameter	Type	Description	Required
user	String	UID of the super administrator account
sign	String	Signature	Required
method	String	v3.MerchantBalance	Required
time	Long	Timestamp	Required

Parameters

Parameter	Type	Description	Required
command	String	getBalance	Required
currency	String	ISO 4217 currency code, for example EUR or CHF	Required
nonce_string	String	Random string, no longer than 32 characters	Required

Signature example:

Sorted parameters concatenated into a URL-style query string

"command=getBalance&currency=EUR&method=v3.MerchantBalance&nonce_string=tw5be5b7sry5prm96s&time=1708422208&user=036870"

Sign stringA using secret_key

The resulting signature is:

"YOUR_SIGNATURE"

Request example:

{
    "user": "036870",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.MerchantBalance",
    "time": 1708422208,
    "data": {
        "command": "getBalance",
        "nonce_string": "tw5be5b7sry5prm96s",
        "currency": "EUR"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "user": "036870",
        "time": 1708422208,
        "gateway_name": "YabandPay",
        "wallet_id": "WA156227511825",
        "currency": "EUR",
        "available": "9999788.98",
        "reserve": "200.00",
        "usable": "9999988.98",
        "deposit": "20.00"
    },
    "message": ""
}

Additional information:

Response parameter descriptions:

Parameter	Type	Description
user	String	UID of the super administrator account
time	String	Current timestamp
gateway_name	String	Institution name
wallet_id	String	Wallet ID
currency	String	Currency code, ISO 4217
available	String	Available balance
reserve	String	Reserve balance
usable	String	Spendable amount, equal to vailable - reserve
deposit	String	Frozen balance