Skip to main content
GET
List accounts

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Query Parameters

page.size
integer<int32>

1..200, default 50

page.cursor
string
query
string

name or code anywhere; account number or owner_ref from the start

currency
string
Example:

"NGN"

category
enum<string>

What the console groups by. Derived from the code's group segment.

WALLET: customer money

SETTLEMENT: mirror of a partner omnibus

INTERNAL: suspense, clearing, fees, FX position, equity

Available options:
WALLET,
SETTLEMENT,
INTERNAL
status
enum<string>
Available options:
ACTIVE,
FROZEN,
CLOSED
ownerRef
string
Example:

"cust_1"

Response

OK

accounts
object[]
page
object
categoryCounts
object

Counts per category for the same query and currency, for the tab strip.