Балансы

GET /balances

Получение текущих балансов мерчанта. Возвращает все типы балансов, сгруппированные по валютам.

Заголовки

Заголовок	Обязательный	Описание
merchant-id	Да	Идентификатор мерчанта
x-signature	Да	HMAC-SHA256 подпись запроса

Query-параметры

Параметр	Тип	Обязательный	Описание
currency	string	Нет	Фильтр по валюте (например, RUB)

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

curl -X GET "https://api.arcanumpay.ru/api/v1/balances?currency=RUB" \
  -H "merchant-id: 12345" \
  -H "x-signature: a1b2c3d4e5f6..."

Ответ

Поле	Тип	Описание
balances	array	Массив объектов баланса, сгруппированных по валюте

Объект баланса

Поле	Тип	Описание
currency	string	Валюта
balanceMain	string	Основной рабочий баланс
balanceHold	string	Зарезервированный баланс
balanceOutcome	string	Зафиксированные исходящие операции
balanceSettled	string	Рассчитанный баланс
balanceRollingReserve	string	Роллинг-резерв
overdraftLimit	string	Лимит овердрафта

Пример ответа

{
  "data": {
    "balances": [
      {
        "currency": "RUB",
        "balanceMain": "15000.00",
        "balanceHold": "500.00",
        "balanceOutcome": "200.00",
        "balanceSettled": "14300.00",
        "balanceRollingReserve": "1000.00",
        "overdraftLimit": "0.00"
      }
    ]
  }
}

Типы балансов

Тип	Описание
Main	Основной рабочий баланс мерчанта, доступный для операций
Hold	Средства, зарезервированные под текущие незавершенные операции
Outcome	Зафиксированные исходящие операции (выводы в обработке)
Settled	Рассчитанный баланс после учета всех подтвержденных операций
Rolling Reserve	Резерв, удерживаемый на определенный период в качестве гарантии
Overdraft Limit	Максимальная сумма, на которую баланс может уходить в минус