Skip to main content
GET
Get total balances and money in and out

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

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.

Maximum string length: 128

Query Parameters

period_start
string<date>

First day of the money-in/out period. Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

period_end
string<date>

Last day (inclusive). Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

Response

OK.

Totals for Home and Accounts.

object
string
required

Always balance_summary.

Allowed value: "balance_summary"
period_start
string<date>
required

Start of the money-in/out period.

Example:

"2026-11-07"

period_end
string<date>
required

End of the period (inclusive).

Example:

"2026-11-07"

currencies
object[]
required

One row per held currency, NGN first.

total
object | null
required

"Total balance" in the reporting currency. Converting other currencies is after launch; until then this is the NGN total.

as_of
string<date-time>
required

When it was created.

Example:

"2026-10-27T08:41:00Z"