curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/balance" \
-H "Authorization: Bearer olive_live_xxx"
{
"success": true,
"agent_id": "agent_abc123",
"business_name": "ABC Money Services",
"balance": 150000000,
"balance_formatted": "1,500,000.00 SLE",
"currency": "SLE",
"last_transaction_at": "2025-01-15T10:30:00Z"
}
{
"error": "Agent not found",
"code": "NOT_FOUND"
}
Agents
Get Agent Balance
Check agent’s current float balance
GET
/
agents
/
{id}
/
balance
curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/balance" \
-H "Authorization: Bearer olive_live_xxx"
{
"success": true,
"agent_id": "agent_abc123",
"business_name": "ABC Money Services",
"balance": 150000000,
"balance_formatted": "1,500,000.00 SLE",
"currency": "SLE",
"last_transaction_at": "2025-01-15T10:30:00Z"
}
{
"error": "Agent not found",
"code": "NOT_FOUND"
}
Request
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)Path Parameters
string
required
Agent UUID (e.g.,
agent_abc123)Response
string
Agent UUID
integer
Float balance in cents
string
Formatted balance (e.g.,
1,500,000.00 SLE)string
Currency code (
SLE)Examples
curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/balance" \
-H "Authorization: Bearer olive_live_xxx"
{
"success": true,
"agent_id": "agent_abc123",
"business_name": "ABC Money Services",
"balance": 150000000,
"balance_formatted": "1,500,000.00 SLE",
"currency": "SLE",
"last_transaction_at": "2025-01-15T10:30:00Z"
}
{
"error": "Agent not found",
"code": "NOT_FOUND"
}
Use Cases
Before Cash-In
Verify sufficient float before processing
Daily Reconciliation
Check end-of-day float position
Errors
| Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Invalid API key |
| 403 | FORBIDDEN | Not authorized to view balance |
| 404 | NOT_FOUND | Agent not found |
| 500 | INTERNAL_ERROR | Server error |
⌘I