Skip to content

Balance

Scope: balance:read. Available in the sandbox, where it is always zero.

GET /v1/balance

json
{
  "object": "balance",
  "currency": "TZS",
  "available_minor": 48120000,
  "settling_minor": 0,
  "settlement": {
    "enabled": false,
    "note": "Settlement is not automated yet. Balances are paid out by arrangement."
  }
}

Read straight from the ledger, not a cache. settling_minor will always be 0 until settlement is automated — the settlement object says so out loud so you do not have to infer it.

A developer seat on the dashboard cannot see the balance, deliberately; a key with balance:read can. Give that scope to the server that reconciles and withhold it from the one that takes payments.

Every code, scope and route on this site is rendered from the API's own source.