Баланс

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

Info

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

Запрос

Info

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

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

Note

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


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

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

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

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

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

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

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

Ответ

status

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

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

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

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

gatewayId обязательный	integer ID банка, шлюза в системе PayCross.
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
      }
   }
}
}