> ## Documentation Index > Fetch the complete documentation index at: https://docs.polygon.technology/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/openapi.yaml get /wallets openapi: 3.0.3 info: title: Polygon OMS Public API version: v26.09.09-0001 description: >- Unified API for moving money between crypto and fiat. Three ways to move money: Transactions (instant, wallet or card funded, including Cash-In for in-person cash deposits), Deposit Addresses (reusable crypto deposit configurations), and Virtual Accounts (dedicated bank accounts that auto-convert fiat to crypto). Standard transactions follow a two-step flow: create a Quote (pricing), then create a Transaction (execution). Cash-in codes generate a one-time deposit code for in-person cash deposits at retail locations. contact: name: Polygon OMS url: https://oms.polygon.technology servers: - url: https://sandbox-api.polygon.technology/v0.13 description: Sandbox - url: https://api.polygon.technology/v0.13 description: Production security: - BearerAuth: [] tags: - name: Auth description: Authentication via FrontEgg - name: Customers description: Customer management and KYC - name: Customer - name: Wallet - name: Quote - name: Transaction - name: CashIns - name: CashLocation - name: Sandbox - name: VirtualAccount - name: Counterparty - name: ExternalAccount - name: Reference - name: DepositAddress paths: /wallets: get: tags: - Wallet summary: List wallets description: >- 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. operationId: listWallets parameters: - name: limit in: query required: false schema: type: integer format: int32 - name: cursor in: query required: false description: Opaque cursor from `nextCursor` on the previous page. schema: type: string - name: customerId in: query required: false description: Scope to a customer. `cst_` prefix. schema: type: string - name: type in: query required: false description: >- Filter by wallet type. An empty value is treated as omitted. `noncustodial` currently returns an empty list. schema: $ref: '#/components/schemas/WalletVariant' - name: search in: query required: false description: Free-text search. Matches wallet id or on-chain address. schema: type: string - name: q in: query required: false description: Alias for `search`. schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WalletList' components: schemas: WalletVariant: type: string enum: - custodial - noncustodial - fiat description: Public wallet variants accepted by the top-level wallet list filter. WalletList: type: object required: - object - data - hasMore properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/WalletListItem' hasMore: type: boolean nextCursor: type: string nullable: true description: Canonical paginated envelope for the top-level wallet list. WalletListItem: type: object required: - id - object - customerId - status - provider - multiAsset - displayName properties: id: allOf: - $ref: '#/components/schemas/typeId' description: Wallet ID (TypeID; `wlt_fiat_` for fiat wallets). object: type: string enum: - wallet description: Resource type discriminator. Always "wallet". customerId: allOf: - $ref: '#/components/schemas/typeId' description: The OMS customer that owns this record (`cst_` prefix). customer: allOf: - $ref: '#/components/schemas/CustomerSummary' description: >- Display-safe summary of the owning customer (`customer.id` equals `customerId`). Returned on list and detail responses. status: allOf: - $ref: '#/components/schemas/WalletResourceStatus' description: Current wire status. provider: type: string description: >- The legal entity holding this wallet's assets, derived from wallet type and asset: `custodial` → "Coinme Inc."; `fiat` (usd) → "Erebor Bank, N.A.". New providers may be added, so treat the string as free-form rather than a fixed set. multiAsset: type: boolean description: >- true when the wallet supports every network in its family and all assets on them; false when restricted to a single asset (fiat, custodial). displayName: type: string description: >- Server-generated wallet name. Custodial wallets use their on-chain address; fiat wallets use `USD balance ()`. Distinct from the optional partner-supplied label. label: type: string nullable: true balances: type: array items: $ref: '#/components/schemas/WalletResourceBalance' metadata: type: object additionalProperties: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time description: >- A wallet as it appears in `GET /wallets` — the fields every wallet type shares, including `balances`. The variant-specific `details` are returned only by `GET /wallets/{id}`. typeId: type: string pattern: >- ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ description: >- Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. x-go-type: string CustomerSummary: type: object required: - id - name properties: id: allOf: - $ref: '#/components/schemas/typeId' description: The OMS customer id (`cst_` prefix). name: type: string description: Customer display name. description: >- Display-safe summary of a customer — ID plus display name only. Enables one-request list rendering: a page of rows needs no per-row detail queries. Always the record's owning customer, not whichever side a party sits on. WalletResourceStatus: type: string enum: - preallocated - active - suspended description: >- `preallocated`: reserved/provisioned but not yet activated. `active`: usable. `suspended`: temporarily disabled (e.g. a compliance or risk hold). There is no terminal value — a closed wallet also reports `suspended`. WalletResourceBalance: type: object required: - asset - network - balance - estimatedValueUsd properties: asset: type: string network: type: string nullable: true description: Null for fiat balances — held on an internal ledger, not a network. balance: $ref: '#/components/schemas/signedFixedDecimalString' estimatedValueUsd: $ref: '#/components/schemas/signedFixedDecimalString' description: >- One (asset, network) balance entry on a wallet. The OMS contract calls this `WalletBalance`; renamed here because the legacy balance-response envelope owns that name. signedFixedDecimalString: type: string description: >- Wire-safe decimal string for signed financial values that must ship with a fixed scale (trailing zeros preserved). It combines the two guarantees the OMS `Customer.totalBalance` fields need at once: the leading minus is part of the contract — a fiat balance may be negative after an ACH clawback, so consumers render the sign as-is and never clamp to zero — and the scale is preserved on the wire (e.g. `"25.00"`, `"-25.00"`, `"0.00"`), unlike `signedDecimalString`/`decimal.Decimal`, whose `.String()` trims trailing zeros (`"25.00"` → `"25"`). Same underlying `numeric.FixedDecimalString` Go type as `fixedDecimalString`; the builder is responsible for setting the scale (via `StringFixed`). x-go-type-import: path: github.com/0xPolygon/bpn-lib/numeric x-go-type: numeric.FixedDecimalString securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: Token from POST /auth/token ````