Skip to main content

Check Agent Balance - /api/v20/balance

Returns the Agent's contract financial parameters: balance, disable and notification thresholds, and contract currency.

Request Structure

ParameterValue
MethodPOST
URI<url>/api/v20/balance
URI Parametersnone
Body Parametersnone
Content-Typeapplication/json

Response Structure

ParameterDescriptionRequired
agentIdAgent identifieryes
agentNameAgent nameyes
balanceCurrent agent balanceyes
overdraftPayment acceptance disable thresholdyes
notificationNotification threshold for agent staffno
currencyContract currencyno

Response Example

{
"result": 0,
"resultMessage": "Success",
"agent": {
"agentId": 101,
"agentName": "Test Agent",
"balance": -4086.1600,
"overdraft": 10000000.0000,
"notification": 0.0000,
"currency": "KZT"
}
}