v1

latestOpenAPI 3.1.02026-07-2630132755.3 KB
depositAddresses

Create new deposit address

Any bridgable tokens sent to a generated deposit address will be automatically bridged to the set up address on the destination chain.

post/deposit-addresses

Request body

depositChainsNonEmptyString[] required

Array of blockchain chain identifiers where deposit addresses should be created (e.g., ["ETHEREUM", "ARBITRUM"]).

addressNotestring

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

reusePolicy'create-new' | 'reuse-existing'

Whether to reuse an existing deposit address that matches the given parameters or always create a new one. By default an existing address is reused unless create-new is specified.

webhookUrlstring

a non empty string

refundAddressstring

a non empty string

destinationChainstring required

The blockchain chain identifier for the destination address (e.g., "BASE").

destinationAddressstring required

The blockchain address where bridged tokens will be sent.

tokenOutstring

Token to be received on the destination address. The deposited token will be swapped automatically if needed.

bridgeIfNotSwappableboolean

Only valid if tokenOut is set as well. If true, deposited tokens that cannot be swapped to the tokenOut will be bridged instead of causing a failed bridge..

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).