Балансы магазина

GET/v2/shops/{shopId}/balances

Возвращает сумму успешных платежей магазина, которая ещё не перечислена на ваш расчётный счёт.

Авторизация. Передайте API-ключ в заголовке Authorization: Bearer <API-ключ>. Подробнее — Авторизация и подпись.

Параметры

Параметр	Где	Тип	Обязательный	Описание
`shopId`	path	integer	да	ID магазина

Пример запроса

curl https://api.zefirpay.com/api/v2/shops/482193/balances \
  -H "Authorization: Bearer $ZEFIRPAY_API_KEY"

Ответы

Код	Значение	Описание
200	OK	Балансы магазина
401	Unauthorized	API-ключ не передан или неверен
403	Forbidden	Магазин не найден или принадлежит другому пользователю

200

{
  "success": true,
  "data": {
    "balances": [
      {"shop_id": 482193, "currency": "rub", "balance": 14565.0, "hold": 0.0, "available": 14565.0}
    ]
  }
}

403

{"success": false, "message": "Магазин не найден или не принадлежит текущему пользователю"}

Схема ответа 200

Поле	Тип	Описание
`success`	boolean	Признак успешного выполнения
`data.balances`	array	Балансы магазина, по одному на валюту

Баланс (элемент balances)

Поле	Тип	Описание
`shop_id`	integer	ID магазина
`currency`	string	Валюта: `rub`
`balance`	number	Сумма успешных платежей за вычетом комиссии, ещё не перечисленная на расчётный счёт
`hold`	number	Зарезервированная сумма
`available`	number	Сумма к перечислению: `balance − hold`