Skip to main content
GET
List wallets
Organization admins see every wallet of the organization; other users see only the wallets shared with them, in any role. On the first page with no filter and no orderBy, your own PERSONAL wallet comes first. Wallets of the other environment are not listed, so send x-environment: LIVE for production wallets. Filter by name (ignoring case — every word in any order for organization admins, the text as typed for other users), status, types, walletProducts, accountId, ids or excludeIds; admins can also filter by ownerIds and sharedUserId. List filters take their values comma-separated (?status=ACTIVE,BLOCKED); repeating the parameter works too. Sort with orderBy + order and page with limit + next. The balances are read live; send includeBalances=false to leave them out, which is faster. A wallet whose balance can’t be read at that moment comes without it.

Headers

x-environment
enum<string>

Environment whose wallets you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST wallets; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose wallets you list.

Format: UUID

Query Parameters

name
string

Only wallets whose name contains this text, ignoring case. For organization admins every word counts on its own, in any order; for other users the text must appear as typed.

Maximum string length: 256
status
string[]

Only wallets in these statuses (case-insensitive): PENDING, ACTIVE, BLOCKED, CANCELLING, CANCELLED, REPROVED, FRAUD_ANALYSIS or FRAUD_CONFIRMED. Other values match no wallet.


Example (comma-separated list): ?status=ACTIVE,BLOCKED

Maximum string length: 64
types
string[]

Only wallets of these kinds (case-insensitive): ORGANIZATION, SHARED, PERSONAL or VEHICLE. Other values match no wallet.


Example (comma-separated list): ?types=SHARED,PERSONAL

Maximum string length: 64
walletProducts
string[]

Only wallets on these card products.


Example (comma-separated list): ?walletProducts=NORMAL,SUPER

ownerIds
string[]

Only wallets whose OWNER is one of these users. Organization admins only: anyone else gets a 403.


Example (comma-separated list): ?ownerIds=e3553bc1-5e20-4e17-b22a-a796fda0aa99,0b6f2c1e-8d4a-4f3b-9a7e-5c2d1e0f9a8b

sharedUserId
string

Only wallets shared with this user, in any role. Organization admins only; ignored for anyone else.

accountId
string

Only wallets of this account. A value that isn't an account ID matches no wallet.

ids
string[]

Only these wallets. Values that aren't wallet IDs match no wallet.


Example (comma-separated list): ?ids=66f2a3d1b4d3e80012c9a0d2,66f2a1d0b4d3e80012c9a0b9

excludeIds
string[]

Leave these wallets out. Values that aren't wallet IDs are ignored.


Example (comma-separated list): ?excludeIds=66f2a1d0b4d3e80012c9a0b9,6710b8e4c9e77b0012a4d6f3

orderBy
string

Field to sort by: createdAt (the default), name, or another wallet field such as updatedAt.

order
enum<string>

Sort direction of orderBy (case-insensitive). Defaults to DESC.

Available options:
ASC,
DESC
includeBalances
enum<string>

false returns the wallets without their balances, which is faster. Balances are included by default.

Available options:
true,
false
next
string

Cursor returned as next by the previous page. Omit it for the first page.

limit
integer

Page size. Defaults to 15 for organization admins and 20 for other users. Your PERSONAL wallet, when it leads the first page, takes one of those slots — except with limit=1, or when an admin omits limit, where that page holds one more.

Required range: x > 0

Response

Successful response

A page of the organization's wallets.

items
object[]
required

The wallets of this page.

next
string | null
required

Cursor of the next page: send it as next to read it. null on the last page.

Example:

"NjZmMmEzZDFiNGQzZTgwMDEyYzlhMGQy"