Skip to main content

4. Balance

Get balance

GET /api/v1/balance

Returns the merchant's current balance and the amount on hold.

Shop routing: when using multiple shops, shop_code is optional. If shop_code is provided, the response is limited to that shop. If shop_code is omitted, the response uses the merchant's default active shop. If no default active shop is configured, the API returns 422.

Headers

Parameter	Type	Required	Description
X-API-Key	string	Yes	API key.
X-Timestamp	string	Yes	Request time.
X-Signature	string	Yes	HMAC-SHA256(secret, timestamp + body). For GET requests the body is empty.

Query parameters

Parameter	Type	Required	Description
shop_code	string	No	Shop code. If not provided, the balance is calculated for the merchant's default active shop.
currency	string	No	ISO currency code. Default — RUB.

Example

GET /api/v1/balance?shop_code=shop-001&currency=RUB

Response 200 (OK)

{
  "currency": "RUB",
  "balance": "98500.00",
  "on_hold": "1500.00"
}

Field	Description
currency	Request currency.
balance	Available balance for the selected shop in this currency.
on_hold	Amount on hold for payout transactions in raw statuses `processing`, `processing_api`, or `waiting_api`.

Values are returned as strings with two decimal places.

Get balance