Skip to main content
PATCH
Update a Deposit Address

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

depositAddressId
string
required

Deposit Address ID (da_ prefix).

Body

application/json

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.

destination
US bank account · object

Re-point the DA destination (bank-type External Account by EA id, or a crypto wallet — walletOms / walletExternal). Re-validated exactly like create.

returnDestination
object

Re-point the registered crypto return destination (v0.11-8). PATCHable per the v0.11-8 contract; send explicit null to clear.

sponsorGas
boolean
default:true

When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported; accepted for forward-compatibility.

label
string

Partner display label.

metadata
object

Free-form key-value pairs stored on the resource and echoed back on reads.

Response

200 - application/json

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.

id
string

Deposit Address ID (da_ prefix).

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})$
object
enum<string>

Resource type discriminator. Always "depositAddress".

Available options:
depositAddress
customerId
string

Public customer id (cst_...). Named customerId to match VA's naming convention.

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})$
status
enum<string>

Current lifecycle status of the deposit address.

Available options:
pending,
active,
frozen,
closed,
failed,
inactiveActionRequired
statusReason
string

Human-readable explanation of the current status.

expectedSourceAsset
string

Asset of the inbound crypto the DA expects.

expectedSourceNetwork
string

Network of the inbound crypto the DA expects.

depositInstructions
object

Null in the 201 until DEPOSIT_ACCOUNT.OPEN populates the Erebor-owned inlet address.

destination
OMS wallet · object

V0.10: unified destination shape (payoutOrigin now lives inside TransactionDestination).

returnDestination
object

Registered crypto return destination (v0.11-8), echoed when set.

failureReason
enum<string>

Set when status = failed; closed enum identifying the failure category.

Available options:
provisioningTimeout,
systemError,
ereborRejected,
intlBankAccountCreateRejected,
noMatchingNetwork,
blockchainAddressInUse,
bankAccountInUse
sourceToDestination
enum<string>

Derived from the destination type: cryptoToFiatAccount for a bank destination, or cryptoToCrypto for a crypto-wallet destination.

Available options:
cryptoToCrypto,
cryptoToCash,
cryptoToFiatAccount,
cashToCrypto,
fiatAccountToCrypto,
fiatAccountToFiatAccount
sponsorGas
boolean

Whether OMS absorbs the on-chain gas cost for the destination delivery. Persisted from the create/update request (currently only true is accepted).

label
string

Partner display label.

metadata
object

Free-form key-value pairs supplied at creation or update.

createdAt
string<date-time>

When the deposit address was created.

updatedAt
string<date-time>

When the deposit address was last updated.