This page covers the custodial
wallet resource of the Payments API. If your product needs users to control their own keys on-chain (consumer apps, agentic flows), use OMS non-custodial wallets. The two models can be combined in a single product.Object
address field is the wallet’s on-chain address. It is read-only and assigned at creation. type is internal for OMS-managed wallets or external for wallets held outside OMS. chain is the canonical chain name (for example, polygon), and blockchainAsset carries the resolved on-chain identity: protocol, chainId, and tokenId.
At launch, wallets are custodial only: a single asset on one chain. Provisioning is scoped per asset and chain, so hold multiple assets by creating one wallet each under the same customer.
Create a wallet
POST /customers/{id}/wallets provisions a wallet for a customer for the requested asset and chain, and returns the created wallet.
Idempotency-Key header to safely retry without provisioning duplicates.
Associate an embedded wallet
POST /customers/{customerId}/wallets/associate links an existing embedded (WaaS) wallet to a customer so subsequent operations reference it like any other wallet. The wallet is identified by a WaaS ID token in the request body: the token’s subject is the wallet ID, so the wallet ID is never passed directly, and the token’s audience must be the authenticated project. The response returns the associated wallet.
Balance
Read a wallet’s current balance withGET /wallets/{id}/balance. The response includes the display balance and its estimated value; pass estimatedBalanceCurrencyCode to value the balance in a currency other than USD (the default).
GET /customers/{id}/balance. See Customers.
Funding a wallet
A wallet can receive funds in three ways:
A direct transfer to the
address credits the wallet balance. Virtual accounts and deposit addresses are the flows where OMS auto-creates a transaction in response to incoming funds.
Transaction history
GET /wallets/{id}/transactions returns a wallet’s transaction history, most recent first, with cursor-based pagination and optional transactionType, since, and until filters. The id path parameter accepts a wallet ID (wlt_ prefix).
Key operations
Programmatic wallet creation via
POST /wallets with an explicit custodyType (custodial or embedded) is coming in an upcoming release. Today, provision wallets under a customer with POST /customers/{id}/wallets.Related
- Virtual accounts: assign a bank account number that auto-funds a destination
- Deposit addresses: set up a monitored crypto address that routes to a destination
- Transactions: move funds out of a wallet via crypto, bank transfer, or cash