Sign in
DepositAddress

Update a Deposit Address

Update a Deposit Address. The patchable fields are destination (re-point to a different bank-type External Account), returnWallet, 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.

patch/deposit-addresses/{depositAddressId}

Path parameters

depositAddressIdstring required

Deposit Address ID (da_ prefix).

Request body

sponsorGasboolean

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

labelstring

Partner display label.

metadataobject

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

Response

The request has succeeded.

idstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

object'depositAddress'

Resource type discriminator. Always "depositAddress".

customerIdstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

status'pending' | 'active' | 'frozen' | 'closed' | 'failed' | 'inactiveActionRequired'

Lifecycle of a Deposit Address. pending: awaiting on-chain address assignment. active: accepting deposits. frozen: deposits held by compliance. inactiveActionRequired: destination unusable, re-point destination to recover. closed: permanently disabled. failed: provisioning failed.

statusReasonstring

Human-readable explanation of the current status.

expectedSourceAssetstring

Asset of the inbound crypto the deposit address expects.

expectedSourceNetworkstring

Network of the inbound crypto the deposit address expects.

failureReason'provisioningTimeout' | 'systemError' | 'ereborRejected' | 'intlBankAccountCreateRejected' | 'noMatchingNetwork' | 'blockchainAddressInUse' | 'bankAccountInUse'

Closed enum carried on DA when status = "failed". camelCase per partner channel naming convention.

sourceToDestination'cryptoToCrypto' | 'cryptoToCash' | 'cryptoToFiatAccount' | 'cashToCrypto' | 'fiatAccountToCrypto' | 'fiatAccountToFiatAccount'

Composite of source and destination instrument categories, inferred from each side. The cash corridors (cryptoToCash, cashToCrypto) are derived from a cash-pickup destination / cash-in source respectively; the rest map straight from the internal corridor type.

sponsorGasboolean

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

labelstring

Partner display label.

metadataobject

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

createdAtstring date-time

When the deposit address was created.

updatedAtstring date-time

When the deposit address was last updated.

Changes

No recorded changes to this endpoint across all 1 revision of this API.