Skip to main content
GET
List accounts

Filtering

Filters are written as field=value, or field:operator=value. balance is compared in minor units, which is how it is stored — filtering NGN by naira is wrong by a factor of a hundred.
To separate your own money from your customers’, filter on ownership rather than inferring it:
There is no filter on the payment provider behind an account, and there will not be: naming the integration that holds a balance is not something a filter should disclose either.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Query Parameters

page
integer
default:1

One-based page number.

Required range: x >= 1
pageSize
integer
default:25

Records per page. A larger value is rejected rather than capped.

Required range: 1 <= x <= 100

Case-insensitive term matched against name and tag. Maximum 100 characters.

Maximum string length: 100
sort
string

Up to three comma-separated keys from name, balance, currency, status, and createdAt. Prefix a key with - for descending order.

name
string

Exact match on your label.

name:contains
string

Substring of your label.

tag
string

Exact match on the public transfer handle.

Pattern: ^[A-Z]{2}\d{10}$
tag:contains
string

Substring of the transfer handle.

type
enum<string>

Filter by account type.

Available options:
operational,
savings,
settlement,
collection,
fee,
revenue,
suspense
type:ne
string

Everything except this type.

type:in
string

Comma-separated account types.

category
enum<string>

Filter by asset category.

Available options:
fiat,
crypto
category:in
string

Comma-separated categories.

status
enum<string>

Filter by status.

Available options:
active,
inactive,
frozen,
closed
status:ne
string

Everything except this status.

status:in
string

Comma-separated statuses.

currency
enum<string>

Filter by asset code.

Available options:
NGN,
USD,
GBP,
EUR,
GHS,
ZAR,
UGX,
CAD,
MXN,
AED,
BTC,
ETH,
USDT,
USDC
currency:in
string

Comma-separated asset codes.

balance
string

Exact balance, in minor units. An integer number of the asset’s smallest unit. Use this value for arithmetic.

Pattern: ^-?\d+$
Example:

"2500000"

balance:gt
string

Balance above this value, in minor units. An integer number of the asset’s smallest unit. Use this value for arithmetic.

Pattern: ^-?\d+$
Example:

"2500000"

balance:gte
string

Balance at or above this value, in minor units. An integer number of the asset’s smallest unit. Use this value for arithmetic.

Pattern: ^-?\d+$
Example:

"2500000"

balance:lt
string

Balance below this value, in minor units. An integer number of the asset’s smallest unit. Use this value for arithmetic.

Pattern: ^-?\d+$
Example:

"2500000"

balance:lte
string

Balance at or below this value, in minor units. An integer number of the asset’s smallest unit. Use this value for arithmetic.

Pattern: ^-?\d+$
Example:

"2500000"

isWalletAccount
boolean

True for customer wallets, false for your own accounts.

customerId
string

Wallets belonging to one customer. A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

customerId:in
string

Comma-separated customer identifiers. At most 50.

customerId:isnull
boolean

true returns only your own accounts; false returns only customer wallets.

createdAt:gt
string<date-time>

Opened after this ISO 8601 timestamp.

createdAt:gte
string<date-time>

Opened at or after this ISO 8601 timestamp.

createdAt:lt
string<date-time>

Opened before this ISO 8601 timestamp.

createdAt:lte
string<date-time>

Opened at or before this ISO 8601 timestamp.

Response

Successful response.

items
object[]
required
pagination
object
required