Menu — Документация

Баланс

Получение текущего баланса мерчанта

GET /balance

Возвращает остаток на основном балансовом счёте мерчанта в валюте баланса и в валюте платежа.

Запрос

curl https://api.menu.casino/balance \
  -H "Authorization: Bearer $MENU_API_TOKEN"

Ответ

Мерчант с историей операций

{
  "status": "Success",
  "data": {
    "amountInCurrencyBalance": 1284.50,
    "currencyBalance": "USDT",
    "amountInCurrencyPayment": 128878.25,
    "currencyPayment": "RUB",
    "exchangeRate": 100.30
  },
  "traceID": "0c4a1b8e-3f7d-44e2-9b6c-1d5f8a2e7c11"
}

Мерчант без успешных операций

{
  "status": "Success",
  "data": {
    "amountInCurrencyBalance": 0,
    "currencyBalance": "USDT",
    "amountInCurrencyPayment": 0,
    "currencyPayment": "RUB",
    "exchangeRate": 0
  },
  "traceID": "5b1d3e0a-6f8b-4a72-9e3a-2c0a1f5d4b21"
}

Невалидный токен

{
  "status": "AuthError",
  "data": null,
  "codeError": "internalError",
  "message": "Not fount user data",
  "traceID": "a91f7c20-8b14-4f3a-9d80-1e2a3c4b5d61"
}

Описание полей

ПолеТипОписание
amountInCurrencyBalancedecimalостаток на основном балансовом счёте
currencyBalanceenumвалюта баланса мерчанта
amountInCurrencyPaymentdecimalостаток, пересчитанный в валюту платежа
currencyPaymentenumвалюта платежа мерчанта
exchangeRatedecimalкурс пересчёта между валютой баланса и валютой платежа

Значение exchangeRate определяется по последней успешно завершённой операции мерчанта. При отсутствии успешных операций возвращается exchangeRate = 0 и amountInCurrencyPayment = 0.

Значение exchangeRate носит справочный характер. Для расчёта сумм конкретной операции применяется курс, возвращаемый в её ответе.

Применение

Эндпойнт предназначен для отображения текущего остатка в интерфейсах мерчанта и для проверки достаточности средств перед инициированием Pay Out. Эндпойнт не предназначен для построения выписки по счёту — для этого применяется POST /operation/operation/list (раздел Операции).

Частота опроса

Рекомендуемая частота опроса — не чаще одного запроса в 5 секунд. Изменения баланса инициируются сменой статусов операций и доставляются через webhook с задержкой, превышающей период опроса; более частые запросы увеличения свежести данных не дают.

On this page