Get total balances and money in and out
Home “Total balance”, “In this month”, “Out”, and the per-currency totals on Accounts. Default period: this month to date (Africa/Lagos).
Error codes: invalid_api_key, parameter_invalid, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always
our own req_… id. We log your value with the request as client_request_id, so support can find a request by
either id. A longer value is refused with 400 parameter_invalid.
128Query Parameters
First day of the money-in/out period. Calendar date, interpreted in Africa/Lagos.
"2026-11-07"
Last day (inclusive). Calendar date, interpreted in Africa/Lagos.
"2026-11-07"
Response
OK.
Totals for Home and Accounts.
Always balance_summary.
"balance_summary"Start of the money-in/out period.
"2026-11-07"
End of the period (inclusive).
"2026-11-07"
One row per held currency, NGN first.
"Total balance" in the reporting currency. Converting other currencies is after launch; until then this is the NGN total.
When it was created.
"2026-10-27T08:41:00Z"