Баланс

Запрос баланса возвращает значение баланса терминала в системе вашего банка-эквайера или провайдера.

Info

Этот запрос не возвращает ваш баланс в системе Overpay.

Запрос

Info

Возможность выполнения запроса баланса, а также параметры запроса зависят от банка-эквайера или провайдера (некоторые банки требуют в запросе параметр account, некоторые - currency). Обратитесь к своему аккаунт менеджеру для уточнения возможности выполнения запроса и его параметров.

Запрос баланса должен быть отправлен как POST запрос на https://gateway.overpay.io/balance с заголовком X-API-Version: 2 и следующими параметрами:

Note

Тело запроса должно быть обёрнуто в корневой объект request{}.


account условно обязательный	string Номер счета (если поле пустое, то вернется информация о счете по умолчанию).
currency условно обязательный	string Валюта в ISO-4217 формате, например `USD`.
gateway_id условно обязательный	string ID банка, шлюза в системе Overpay.

Пример запроса баланса по номеру счета

{
   "request":{
      "account":"40701810842020395221"
   }
}

Пример запроса баланса по валюте

{
   "request":{
      "currency":"USD"
   }
}

Пример запроса баланса по ID банка

{
   "request":{
      "gateway_id":"1"
   }
}

Ответ

status

обязательный

string
Статус ответа.

обязательный

object
Результат ответа.

gatewayId обязательный	integer ID банка, шлюза в системе Overpay.
account	string Номер счета.
amount	integer Баланс счета в минимальных денежных единицах.
currency	string Валюта. Указывается, если банк сообщил ее в ответе или если банк обрабатывает транзакции лишь в одной валюте.
bankInfo	object Дополнительная информация в предоставленном банком формате.

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

{
"status": "successful",
"result": {
   "gatewayId": 5,
   "account": "40701810820020300021",
   "amount": 6623871674,
   "currency": "RUB",
   "bankInfo": {
      "Account": "40701810820020300021",
      "Amount": 66238716.74,
      "Balance": {
      "OperDate": "2021-12-15T00:00:00",
      "Credit": 0.0,
      "CreditRub": 0.0,
      "Debit": 0.0,
      "DebitRub": 0.0,
      "AmountIn": 132339134.78,
      "AmountInRub": 132339134.78,
      "AmountOut": 132339134.78,
      "AmountOutRub": 132339134.78
      }
   }
}
}

Запрос баланса при использовании сервиса контроля выплат

Если Overpay использует сервис контроля выплат и ограничивает сумму выплат, которую может совершить торговец для определенного магазина через определенный шлюз (эквайера) в заданной валюте, у торговца есть возможность запросить информацию о доступной сумме для выплат через API.

Запрос

Отправьте GET запрос на https://backoffice.overpay.io/shop/channel_balances/?gateway_id={gateway_id}&currency={currency} со следующими параметрами строки запроса (query):


gateway_id обязательный	integer ID платежного шлюза для вашего магазина в системе Overpay. Чтобы получить идентификатор шлюза, обратитесь в службу поддержки или к вашему менеджеру.
currency	string Валюта шлюза, для которой запрашивается доступный баланс для выплат, в формате ISO-4217 alpha-3 code. Например, `USD`.

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

curl --location 'https://backoffice.overpay.io/shop/channel_balances?gateway_id=3405&currency=USD' \
--header 'content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic MT******MDY1' \
--data ''

Ответ

code

обязательный

string
Код обработки транзакции.

message

обязательный

string
Системное сообщение для торговца с описанием кода ошибки из параметра code.

friendly_message

обязательный

string
Сообщение для торговца и покупателя с описанием кода ошибки из параметра code.

object
Секция с информацией о доступных балансах.

as_of_date

обязательный

string/datetime
Дата и время, на которые показан баланс канала в формате YYYY-MM-DDThh:mm:ss.SSSZ в часовом поясе UTC.

gateway_id

обязательный

integer
Идентификатор шлюза канала, по которому показан баланс.

array of objects
Массив балансов для выплат.

currencу	string Значение параметра `currency` из запроса.
available_balance	bigInt Сумма баланса в минимальных денежных единицах в указанной валюте.
channel_id	integer Идентификатор канала для выплат.
active	boolean Признак активации контроля выплат для шлюза в данной валюте.

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

{
    "code": "S.0000",
    "message": "Successfully completed.",
    "friendly_message": "Successfully completed.",
    "channel_balances": {
        "as_of_date": "2026-02-16T08:10:10.973Z",
        "gateway_id": 3405,
        "currencies": [
            {
                "channel_id": 1385,
                "currency": "USD",
                "available_balance": 50000,
                "active": false
            }
        ]
    }
}