Create a Deposit Address
Create a Deposit Address. Requires deposit addresses to be enabled for your project and the customer to be provisioned with the banking provider. The address starts pending and becomes active once the inbound on-chain address is assigned.
Authorizations
Token from POST /auth/token
Headers
Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.
Body
Create a Deposit Address: the expected inbound asset/network pair plus the bank destination that receives the converted funds.
Owning customer (cus_… or legacy public id).
Asset of the inbound crypto the DA expects. "usdc" | "usdt" (lowercase).
Network senders will use for the inbound deposit. Availability is per-provider rather than one global list: a network outside the CryptoNetwork vocabulary, or one the provider that issues your Deposit Address does not serve, is rejected with 422 expectedSourceNetworkUnsupported. GET /networks reports the networks your project can currently receive on.
ethereum, polygon, base, solana, tron Where the Deposit Address delivers converted funds. Pick a type: a bank account (bankUs, on ach / achSameDay / wire / rtp; bankIban; bankCanada) or a fiat balance wallet (walletFiat) for crypto-to-fiat, or a registered external crypto wallet (walletExternal) for crypto-to-crypto. A walletExternal network must be one the Deposit Address's own provider serves — per provider, not one global list — or it is rejected with 422 destinationNetworkUnsupported. walletFiat credits the customer's own fiat wallet by internal book transfer, so the resolved destination instrument reads network: bookTransfer. walletCrypto is rejected with 422 destinationWalletCryptoNotSupported. The side details (asset and network) are validated against the resolved External Account or wallet.
- US bank account
- IBAN bank account
- Canadian bank account
- OMS wallet
- External wallet (registered)
- Fiat wallet
Registered crypto return destination (v0.11-8), for operations-triggered returns of stranded inbound deposits.
When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported. Ignored for non-crypto destinations (no on-chain leg).
Partner display label.
Free-form key-value pairs stored on the resource and echoed back on reads.
Response
The request has succeeded and a new resource has been created as a result.
A reusable crypto deposit configuration. Senders deposit the expected asset/network to the assigned on-chain address; OMS converts and delivers the funds to the configured bank destination automatically, creating a transaction per inbound deposit.
Deposit Address ID (da_ prefix).
^[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})$Resource type discriminator. Always "depositAddress".
depositAddress Public customer id (cst_...). Named customerId to match VA's naming convention.
^[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})$Display-safe summary of the owning customer (customer.id equals customerId). Returned on list and detail responses.
Current lifecycle status of the deposit address.
pending, active, frozen, closed, failed, inactiveActionRequired Human-readable explanation of the current status.
Asset of the inbound crypto the DA expects.
Network of the inbound crypto the DA expects.
ethereum, polygon, base, solana, tron Populated in the create response when the provider assigns the address up front. Otherwise it is null until the provider has assigned the on-chain address: poll GET /deposit-addresses/{depositAddressId} until it is populated before giving a sender deposit instructions.
V0.10: unified destination shape (payoutOrigin now lives inside TransactionDestination).
- OMS wallet
- External wallet
- Fiat wallet
- US bank account
- IBAN bank account
- Canadian bank account
- Card
- Cash
Registered crypto return destination (v0.11-8), echoed when set.
Set when status = failed; closed enum identifying the failure category.
provisioningTimeout, systemError, ereborRejected, intlBankAccountCreateRejected, noMatchingNetwork, blockchainAddressInUse, bankAccountInUse Derived from the destination type: cryptoToFiatAccount for a bank destination, or cryptoToCrypto for a crypto-wallet destination.
cryptoToCrypto, cryptoToCash, cryptoToFiatAccount, cashToCrypto, fiatAccountToCrypto, fiatAccountToFiatAccount Whether OMS absorbs the on-chain gas cost for the destination delivery. Persisted from the create/update request (currently only true is accepted).
The institution that issues and custodies this Deposit Address — currently "Erebor Bank, N.A." or "Coinme Inc.". Assigned by OMS from your project's configuration. It determines which expectedSourceAsset / expectedSourceNetwork pairs you can use: an unsupported pair is rejected at create time with 422 depositAddressAssetNetworkNotSupported, which names the same provider in details.provider. Read it when you need to tell an end user or a support ticket which institution is holding the funds. It is not the entity an outbound payment is sent under — that is payoutOrigin.accountHolderName, which is set by whoever executes the payout and can name a different company. New providers may be added, so treat the string as free-form rather than a fixed set. Read-only; omitted when the issuing institution is not recognised.
Whether a sender's wallet must be registered as a walletExternal External Account under this Deposit Address's customer before it deposits. Derived from the issuing provider, never supplied by you: Deposit Addresses issued by Erebor Bank, N.A. accept a deposit only from a registered counterparty wallet (true), while those issued by Coinme Inc. accept a deposit from any crypto address (false). When true, a deposit from an unregistered address still arrives, but its transaction parks on a senderAttribution hold until you register a matching External Account (the hold's matchableExternalAccountCriteria says what will match) and fails at the hold's deadline if you never do — so capture the sender's address up front. When false, there is nothing to register against, so skip that step entirely. Read it per Deposit Address rather than caching it per project. Read-only, and omitted when OMS cannot identify the issuing provider — treat the requirement as undetermined rather than assuming either regime.
Partner display label.
Free-form key-value pairs supplied at creation or update.
When the deposit address was created.
When the deposit address was last updated.