Баланс
Запрос баланса можно использовать для уточнения данных баланса счета.
Запрос
Info
API запроса баланса зависит от банка-эквайера (некоторые банки требуют в запросе параметр account
, некоторые - currency
). Обратитесь к своему Аккаунт-менеджеру для уточнения параметров запроса.
Запрос баланса должен быть отправлен как POST
запрос на https://gateway.unonapay.com/balance
с заголовком X-API-Version: 2
и следующими параметрами:
Параметр | Тип | Описание |
---|---|---|
account * условно обязательный |
string | Номер счета (если поле пустое, то вернется информация о счете по умолчанию). |
currency * условно обязательный |
string | Валюта в ISO-4217 формате, например USD . |
gateway_id * условно обязательный |
string | ID банка, шлюза в системе UnonaPay. |
Пример запроса баланса по номеру счета
{
"request":{
"account":"40701810842020395221"
}
}
Пример запроса баланса по валюте
{
"request":{
"currency":"USD"
}
}
Пример запроса баланса по ID банка
{
"request":{
"gateway_id":"1"
}
}
Ответ
Параметр | Тип | Описание |
---|---|---|
status * обязательный |
string | Статус ответа. |
result * обязательный |
object | Результат ответа. |
gatewayId * обязательный |
integer | ID банка, шлюза в системе UnonaPay. |
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
}
}
}
}