Баланс

GET /v1/balance - доступные и замороженные средства по API-ключу

GET/api/v1/balance

Описание

Возвращает те же цифры, что раздел «Баланс» в кабинете. Деньги - целым числом в копейках.

Баланс считается по всему аккаунту владельца магазина: все его магазины, партнёрские начисления и выплаты вместе. Ключ любого магазина аккаунта вернёт одну и ту же сумму - учитывайте это, если передаёте ключ подрядчику под отдельный магазин.

Поля ответа

availableKopecks

integer

Доступно к выводу, в копейках: размороженное нетто успешных платежей плюс размороженное партнёрское вознаграждение минус зарезервированное заявками на выплату.

frozenKopecks

integer

Заморожено, в копейках: свежие поступления и партнёрские начисления до отсечки разморозки.

holdHour

integer

Час разморозки по Москве: платёж дня D становится доступен после этого часа дня D+1.

Заморозка и лимиты

Свежие поступления попадают сначала в frozenKopecks и становятся доступными после holdHour по Москве следующего дня. В этот час баланс меняется «скачком» - это разморозка, а не потеря денег.

Лимит - 60 запросов в минуту по ключу. Баланс меняется оплатами и разморозкой: опрашивать его чаще раза в минуту нет смысла - при превышении придёт 429.

Запрос

curl https://tabpay.org/api/v1/balance \
  -H "X-Api-Key: tp_ваш_ключ"

Ответ 200

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