Search for wallets in a tenant

Returns wallets matching the provided search criteria. At least one search field should be supplied; use onlyShowAllowed to restrict results to wallets the caller has permission to access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
Query Params
boolean
deprecated

Deprecated. Use 'obfuscate' instead.

string

Wallet account number.

string

External unique ID assigned to the wallet at creation.

string

Comma-separated list of additional fields to include in the response.

string

Customer's last (family) name. Max 50 characters.

string

National identity number. Max 20 characters.

boolean

When true, sensitive personal data in the response is obfuscated.

boolean
Defaults to false

When true, returns only wallets the caller has permission to access. When false and the caller lacks permission, an error is returned.

string

Passport number. Max 20 characters.

string

Phone number with or without country code, e.g. 0821112222 or 27821112222.

string

Comma-separated wallet statuses to filter by. Valid values: active, barred, pending, cancelled, locked.

string

Wallet friendly ID. Exactly 8 characters when provided.

int64

Wallet ID to search for directly.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json