Account balance
You can send a request to get your settlement or escrow account balance. You can only get the balance of an account that starts with the following numbers:
- 40702
- 40703
- 40802
- 40807
- 40701
To get the balance, use the account_balance
method.
Request parameters
Name | Mandatory | Type | Description |
---|---|---|---|
account_number | + | string | Account number. The account number must start as follows: 40702 , 40703 , 40802 , 40807 , 40701 |
Request example
https://demo.bank131.ru/api/v1/report/account_balance \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"account_number": "40702810400000000333"
}'
Response parameters
Name | Mandatory | Type | Description |
---|---|---|---|
status | + | string | Status. Options: error , ok |
account_number | - | string | Account number |
account_currency | - | string | Account currency according to ISO 4217. Example: RUB |
balance | - | object | Balance details |
error | - | object | Error |
Successful response example
{
"status": "ok",
"account_number": "40702810400000000333",
"account_currency": "RUB",
"balance": {
"current_balance": 20900
}
}
Unsuccessful response example
{
"status": "error",
"error": {
"code": "Error code",
"description": "Error description"
}
}