Skip to main content
GET
List the realm's wallets
Each wallet comes without its name, users, settings and kind — read a wallet for those. Filter by status and type, which take their values comma-separated (?status=ACTIVE,BLOCKED), and page with limit + next. Wallets of the other environment are not listed, so send x-environment: LIVE for production wallets.

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

Query Parameters

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
type
string[]

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


Example: ?type=ORGANIZATION

Maximum string length: 64
next
string

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

limit
integer

Page size. Defaults to 15.

Required range: x > 0

Response

Successful response

A page of wallets.

items
object[]
required

The wallets of this page, newest first.

next
string | null
required

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

Example:

"NjZmMmEzZDFiNGQzZTgwMDEyYzlhMGQy"