Update a Deposit Address
Update a Deposit Address. The patchable fields are destination
(re-point to a different bank-type External Account), 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.
Authorizations
Token from POST /auth/token
Path Parameters
Body
Partial update payload for a Deposit Address. The patchable fields are
destination (re-point to a different bank-type External Account), 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. Mirrors
VirtualAccountUpdateRequest.
Re-point the DA destination (bank-type External Account by EA id). Re-validated exactly like create.
- Option 1
- Option 2
- Option 3
Partner display label.
When true, OMS absorbs the on-chain gas cost for the destination
delivery. Only true is currently supported; accepted for
forward-compatibility.
Response
The request has succeeded.
Public customer id (cst_...). Named customerId to match VA's naming convention.
Null in the 201 until provisioning populates the OMS-owned inlet address. Top-level mirror of the virtual account's bankDetails.
Unified destination shape (payoutOrigin lives inside TransactionDestination).
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Asset of the inbound crypto the DA expects.
Network of the inbound crypto the DA expects.
v2: closed enum carried on DA when status = "failed". camelCase per partner channel naming convention.
provisioningTimeout, systemError, ereborRejected, intlBankAccountCreateRejected, noMatchingNetwork, blockchainAddressInUse, bankAccountInUse depositAddress pending, active, frozen, closed, failed, inactiveActionRequired Always TransferType.cryptoToFiat for DA. Reuses the existing TransferType enum (instead of a string literal) to avoid collision-driven renames on the generated oapi enums - see feedback_reuse_enums_over_collision memory.
cryptoToCrypto, fiatToCrypto, cryptoToFiat