v1

latestOpenAPI 3.0.32026-07-264469137.7 KB

Accounts

Retrieve balances

Return organization balance buckets by currency, including available, locked, and pending amounts, plus a consolidated USD total.

get/v1/accounts/balances

Response

Success - Account balances retrieved

account_idstring required

Organization ID the returned balances belong to.

total_balance_usdstring required

Aggregate of available and pending balances converted to USD.

pending_settlements_by_dayobject[]

Upcoming settlements grouped by day. Empty when no settlements are pending. Each entry describes settlements expected to become available on a given date.

Example response

{
  "account_id": "org_abc123",
  "balances": [
    {
      "currency": "NGN",
      "available_balance": "250000.00",
      "pending_balance": "15000.00"
    }
  ],
  "total_balance_usd": "1375.00",
  "pending_settlements_by_day": []
}

All 44 operations