Get Agent Balance

GET/agents/{id}/balanceOpen in the API playground →

Request

Authorizationstringheaderrequired

Bearer olive_live_xxx or Bearer eyJ... (JWT)

Path Parameters

idstringpathrequired

Agent UUID (e.g., agent_abc123)

---

Response

agent_idstring

Agent UUID

balanceinteger

Float balance in cents

balance_formattedstring

Formatted balance (e.g., 1,500,000.00 SLE)

currencystring

Currency code (SLE)

---

Examples

Request

cURL

curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/balance" \
  -H "Authorization: Bearer olive_live_xxx"

Response

200 Success

{
  "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"
}

404 Not Found

{
  "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