Balance

GET /v1/balance - available and frozen funds for the API key

GET/api/v1/balance

Overview

Returns the same figures as the Balance section of the dashboard. Money is an integer amount in kopecks.

The balance is calculated across the shop owner's entire account: all of their shops, partner rewards, and payouts combined. A key of any shop on the account returns the same amount - keep this in mind if you hand a key to a contractor for a single shop.

Response fields

availableKopecks

integer

Available for payout, in kopecks: the unfrozen net of successful payments plus unfrozen partner rewards, minus the amount reserved by payout requests.

frozenKopecks

integer

Frozen, in kopecks: recent incoming payments and partner rewards before the unfreeze cutoff.

holdHour

integer

Unfreeze hour in Moscow time: a payment made on day D becomes available after this hour on day D+1.

Hold and rate limits

Recent incoming payments land in frozenKopecks first and become available after holdHour Moscow time on the next day. At that hour the balance changes in a single jump - that is the unfreeze, not lost money.

The limit is 60 requests per minute per key. The balance only changes with payments and the unfreeze: there is no point polling it more than once a minute - exceeding the limit returns a 429.

Request

curl https://tabpay.org/api/v1/balance \
  -H "X-Api-Key: tp_your_key"

Response 200

{
  "availableKopecks": 1250000,
  "frozenKopecks": 89000,
  "holdHour": 12
}