Check Agent Balance - /api/v20/balance
Returns the Agent's contract financial parameters: balance, disable and notification thresholds, and contract currency.
Request Structure
| Parameter | Value |
|---|---|
| Method | POST |
| URI | <url>/api/v20/balance |
| URI Parameters | none |
| Body Parameters | none |
| Content-Type | application/json |
Response Structure
| Parameter | Description | Required |
|---|---|---|
agentId | Agent identifier | yes |
agentName | Agent name | yes |
balance | Current agent balance | yes |
overdraft | Payment acceptance disable threshold | yes |
notification | Notification threshold for agent staff | no |
currency | Contract currency | no |
Response Example
{
"result": 0,
"resultMessage": "Success",
"agent": {
"agentId": 101,
"agentName": "Test Agent",
"balance": -4086.1600,
"overdraft": 10000000.0000,
"notification": 0.0000,
"currency": "KZT"
}
}