Method balance-info
URL: GET - /partner/deposit/balance
The method allows you to get information about the balance of the partner's deposits.
Header parameters
| Parameter | Type | Description |
|---|---|---|
| client-id * | authorization | Unique Partner ID |
| client-secret * | authorization | Unique authentication key for VIA API |
Request parameters
A request is sent without parameters.
Request sample
curl GET '/partner/deposit/balance' \
--header 'client-id: system' \
--header 'client-secret: system123'
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | array | Data array of partner deposits |
| balance | integer | The remaining amount of the deposit in cents (1/100 part of the base currency unit) |
| balanceInUzs | integer | The remaining amount of the deposit in Uzbek sums (1/100 part of the base currency unit) |
| currency | string | Currency: «UZS» - Uzbek sum |
| status | string | Status of the partner's deposit account «ACTIVE» - Active «INACTIVE» - Inactive |
Example response if successful
{
data: [
{
"balance": 10000,
"balanceInUzs": 10000,
"currency": "UZS»,
"status": "ACTIVE",
}
]
}
Example response in case of error
{
"status": {
"code": "1234",
"message": "Error while executing the request"
},
"error": {
"path": "URL Path",
"message": {
"uz": "Error message in Uzbek",
"ru": "Error message in Russian",
"en": "Error message in English"
}
}
}