API Reference

API Reference

Account

Read your organization's account status and live balances.

GETRequires a Bearer token/api/ext/v1/account

Get account status and balances

Responses

200Account status and live balances for your organization.
FieldTypeDescription
balanceoptionalAccountBalance
org_idrequiredstringYour organization id.
statusrequiredstring"open" (managed account exists; balance populated) or "not_open" (no account for this org; balance null).
synced_atoptionalstring · date-timeWhen the balance was last read from the provider.
200 example
{
  "balance": {
    "available_cents": 1250000,
    "holding_cents": 0,
    "locked_cents": 0,
    "pending_cents": 50000
  },
  "org_id": "org_9f3k2p",
  "status": "open",
  "synced_at": "2026-01-15T09:30:00Z"
}

Errors

401Missing or invalid API token
403Token lacks the required scope or credential class
429Rate limit exceeded
503Account state temporarily unavailable (live read failed) — retry later; never returned as a zero balance or a fabricated status.

All errors return { "error": string }.

Example request

curl https://api.bankofbots.ai/api/ext/v1/account \
  -H "Authorization: Bearer $BOB_API_TOKEN"
Was this page helpful?