Update a Deposit Address
Update a Deposit Address. The patchable fields are destination (re-point to a different bank-type External Account), returnDestination, label, and metadata; any other JSON key in the body is rejected with 400. Re-pointing destination to a healthy bank External Account recovers a DA from inactiveActionRequired back to active.
Body
Partial update payload for a Deposit Address. The patchable fields are destination (re-point to a different bank-type External Account), returnDestination, label, and metadata. Any additional key in the JSON body is rejected with 400 by the handler (strict whitelist).
Re-pointing destination to a healthy bank External Account recovers a DA from inactiveActionRequired back to active; a re-point on an already active DA updates the target without a status transition.
Re-point the DA destination (bank-type External Account by EA id, a registered walletExternal crypto wallet, or a walletFiat fiat wallet). Re-validated exactly like create; walletCrypto is NOT currently supported — 422 destinationWalletCryptoNotSupported. Switching between destination kinds (bank / cryptoWallet / walletFiat) involving walletFiat is rejected with 422 destinationTypeSwitchNotSupported.
- US bank account
- IBAN bank account
- Canadian bank account
- OMS wallet
- External wallet (registered)
- Fiat wallet
Response
The request has succeeded.
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.
A Deposit Address is permanent: there is no delete operation for a Deposit Address. The on-chain address is published to senders and can receive a deposit at any time, so removing the record would strand any funds that arrive afterwards with nothing to route them to. The terminal closed status is not a partner call either: it is reached through the provider's own lifecycle or an operator action, and a closed Deposit Address is still not deleted — it stays retrievable by id. To stop using one, stop handing its address to senders. PATCH destination changes where deposits that arrive afterwards are delivered; a deposit that has already arrived keeps the destination that was in effect when it arrived. Contrast a Virtual Account, which does support DELETE because its close is a real provider-side account closure.
What a sender deposits and where. The asset and network are there from creation; the on-chain address is left out until the provider issues it. A provider that issues it during the create call returns it in the create response; otherwise the deposit address turns active once it is issued, and reading it returns the address from then on.
The return destination types this Deposit Address accepts, derived by OMS from its issuing provider and its depositInstructions.network with the same rules a returnDestination is validated against on create and PATCH. walletExternal is listed when the provider serves this network for the network's External Account family; walletCrypto is listed when the provider can return to an OMS wallet. Read-only. Left out when no return destination can be configured on this Deposit Address and when OMS could not determine it; the create and PATCH validation stays authoritative.
The type of a crypto return destination: an OMS wallet (walletCrypto) or a registered external wallet (walletExternal).
walletCrypto, walletExternal 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 asset and network pairs you can create a deposit address for: 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 name a payout is sent under, which is the payout transfer's originatorName 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.
Present, and true, when 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, while those issued by Coinme Inc. accept a deposit from any crypto address and leave the field out. 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. Read it per Deposit Address rather than caching it per project. Read-only. Also left out when OMS cannot identify the issuing provider.