Skip to main content
GET
List an account'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. Two parameters answer a plain array of wallets instead of a page. ids reads those wallets — each with its name, users, settings, kind and live balances (totalBalance, balances); a listed wallet that can’t be read is left out, but the first one must exist and its balance must be readable. forceBalanceResponse=true adds the live balances of the page’s ACTIVE wallets, leaves out a wallet whose balance can’t be read at that moment, and has no next page. Any member of the organization can list its 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

organizationId
string<uuid>
required

ID of the organization the account belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

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 (comma-separated list): ?type=SHARED,PERSONAL

Maximum string length: 64
ids
string[]

Read these wallets, with their balances, instead of listing. The response is then a plain array of wallets, not a page.


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

Maximum array length: 100
Pattern: ^[0-9a-fA-F]{24}$
forceBalanceResponse
enum<string>

true adds the balances of the page's ACTIVE wallets. The response is then a plain array of wallets, not a page.

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.

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"