List wallets
Lists the balance-holding wallets provisioned in the project, most recent first — fiat and custodial. Internal deposit-routing addresses and native gas-token wallets (e.g. pol, eth, sol) are not returned. Omitting customerId returns every wallet in the project; providing it scopes the list to that customer. A well-formed customerId that matches no customer returns an empty list; a present-but-blank customerId is a 400. Each item carries its own customerId. When customerId names a customer enrolled with the custody provider and type is either omitted or custodial, the listing refreshes that customer’s custodial wallets from the custody provider before rendering; every other request, the project-wide listing included, is served from OMS’s own records with no per-request provider call. Balances are re-read on that same refresh only once the stored values have aged past a freshness window. The refresh is best-effort and no failure of it is ever surfaced, whatever its cause: the response carries the records OMS holds.
Authorizations
Token from POST /auth/token
Query Parameters
Opaque cursor from nextCursor on the previous page.
Scope to a customer. cst_ prefix.
Filter by wallet type. An empty value is treated as omitted. noncustodial currently returns an empty list.
Public wallet variants accepted by the top-level wallet list filter.
custodial, noncustodial, fiat Free-text search. Matches wallet id or on-chain address.
Alias for search.
claimed widens the default page to include wallets that default listing otherwise omits — see WalletListHidden. Omitting this param leaves default behavior unchanged. It also admits a custodial wallet the address-reuse guard would otherwise exclude, since both guards run as one exclusion pass.
Values GET /wallets' includeHidden param accepts. claimed widens the default page to include wallets a live deposit address or virtual account currently claims. Omitting the param leaves default listing behavior unchanged.
No deleted value: the single-wallet read path (GET /wallets/{id}, PATCH, /transactions) always filters deleted_at IS NULL, so a soft-deleted wallet the list surfaced would 404 on every follow-up read.
claimed Response
The request has succeeded.
Canonical paginated envelope for the top-level wallet list.
list The custodial variant — one crypto asset on one network, held on the customer's behalf by the custody provider, currently "Coinme Inc.". details.address is the on-chain deposit address and is omitted until the provider reports one.
- Custodial wallet
- Fiat wallet