Search Wallets

Searches the wallets of every holder in your wallet program, with their balances.

Use it to list wallets, find a holder's wallet by email or name, or find wallets by balance. The balances come from a
search index and can be a few seconds behind. Before you charge a wallet or decide on its balance, read it with
Get Wallet.

Requires the Wallet Management permission (see Invite Wallet Holder).

Filterable and sortable fields: walletId, holderId, currency, status, user.email, user.firstName,
user.lastName, user.businessName, balances.*.value, balances.*.wholeValue, lastActivityAt, activityAt,
createdAt, updatedAt.

  • Results are sorted by activityAt descending unless you send sort. A sort on lastActivityAt is applied as a sort on
    activityAt, so wallets with no activity sort by their creation date.
  • pageSize is 10–1000; above 100 it is reduced to 100. page × pageSize cannot exceed 10,000.
  • A wallet program with no wallets returns an empty page.

Errors

  • 400 VALIDATION_ERROR: a filter or sort names a field not listed above, pageSize is out of range, or page × pageSize
    is over 10,000
  • 400 INVALID_REQUEST: the search engine rejected the filter, for example a value of the wrong type for the field
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
object

Conditions a record must match. Omit to return every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order, applied in the order listed.

sort
number
10 to 1000
Defaults to 100

Records per page, between 10 and 1000. Defaults to 100. page × pageSize cannot exceed 10,000; narrow the filter to reach
older records.

number
≥ 1
Defaults to 1

Page to return, starting at 1. Defaults to 1.

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