v1

latestOpenAPI 3.1.02026-07-2630132755.3 KB

depositAddresses

Pause, unpause, or update deposit addresses

Pauses or unpauses deposit address(es) matching the given address, or updates the destination address using signature authorization. For Pause and Unpause, depositChain limits the action to one chain when provided; otherwise all matching deposit addresses are affected. Signature-authorized destination updates require custom per-project setup and are not generally available.

patch/deposit-addresses/{depositAddress}

Path parameters

string required

a string that will be trimmed

string required

Tron basic address format

string required

Request body

Response

Success

depositChainstring required

The blockchain network identifier where the deposit address is located.

depositAddressstring required

The generated deposit address where users should send tokens.

destinationChainstring required

The blockchain network identifier where bridged tokens will be sent.

destinationAddressstring

a non empty string

addressNotestring

Optional note or label for the deposit address (max 80 characters).

isActiveboolean required

Whether this deposit address is currently active and accepting deposits.

isPausedboolean required

Whether this deposit address is currently paused. Paused addresses reject incoming deposits until they are unpaused.

tokenOutstring

Optional token to receive after bridging (for token swaps).

refundAddressstring

a non empty string

bridgeIfNotSwappableboolean

Whether to bridge tokens even if they cannot be swapped (optional).