List wallets
Lists the balance-holding wallets provisioned in the project, most recent first — fiat and custodial — unless orderBy=balance is set. Balance ordering uses available balance valued in USD; balances without a USD estimate are placed last. The default direction is descending. Balance ordering uses live values, not a point-in-time snapshot. Balance or token decimal metadata changes between pages can cause wallets to be skipped or repeated during traversal. 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 customer, an object holding the owning customer’s id. 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, but only once the stored wallet list has aged past a freshness window; every other request, the project-wide listing included, is served from OMS’s own records with no provider call at all. Balances are re-read on that same refresh only once the stored values have aged past their own, shorter freshness window, so a repeated listing inside both windows reaches no provider. A customer holding no stored balances yet is the exception: there is nothing for the balance window to age, so that customer’s listing re-reads balances from the provider every time until the first one is stored. The refresh is best-effort and no failure of it is ever surfaced, whatever its cause: the response carries the records OMS holds. Balance ordering requires stored balances and token decimal metadata; failure to load either returns 500.
Query Parameters
Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.
Filter by wallet type: custodial and fiat return rows whose type is walletCrypto and walletFiat. 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 claimed adds wallets that a live deposit address or virtual account currently claims, which the default page leaves out. It also includes custodial wallets the default page leaves out for address reuse. Omitting this param leaves default behavior unchanged.
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. Deleted wallets are never listed.
claimed Response
The request has succeeded.
Canonical paginated envelope for the top-level wallet list.
The page of results.
The walletCrypto variant — one crypto asset on one network, held on the customer's behalf by the custody provider, currently "Coinme Inc.". address is the on-chain deposit address and is omitted until the provider reports one.
- Crypto wallet
- Fiat wallet