Skip to main content
POST
Generate a new smart deposit address

Authorizations

Authorization
string
header
required

JWT token for authentication

Body

application/json
depositChains
string[]
required

An array of blockchain names where deposit addresses should be created, e.g. ["ETHEREUM", "AVALANCHE"].

Minimum array length: 1

a non empty string

Minimum string length: 1
destinationChain
string
required

The blockchain that the tokenOut will be bridged to, e.g. "AVALANCHE".

Minimum string length: 1
destinationAddress
string
required

The address where tokenOut will be bridged to, e.g. "0x123...ABC".

Minimum string length: 1
addressNote
string

The ability to add a note or label for the deposit address as a reference, e.g. "clientID12345678".

Maximum string length: 80
reusePolicy
enum<string>

Whether the Smart Deposit Address generated should be a re-use of an existing one which matches the given parameters or a new Smart Deposit Address. "create-new" will generate a new Smart Deposit Address and "reuse-existing" will provide an already generated Smart Deposit Address. If omitted, an existing matching Smart Deposit Address is reused where one is available, otherwise a new one is created.

Available options:
create-new,
reuse-existing
webhookUrl
string

A URL that success or failure events related to this bridging transaction should be sent to, e.g. "https://client.com/rhino-webhook". If a webhook address has been set via the Rhino.fi Console then an entry here will override that.

Minimum string length: 1
refundAddress
string

An address that funds should be returned to in the event that the transaction is unsuccessfully executed. However we recommend that this is not set and is managed on a case by case basis with your Rhino.fi Account Manager, to avoid situations whereby funds are returned to pooled addresses on an exchange or into an address that the user no longer has control over.

Minimum string length: 1
postBridgeData
object

Custom Routing Rules as configured by Rhino.fi for specific clients, e.g. to move funds after the initial bridge into a yield bearing vault. To understand more about how Routing Rules can help automate onchain actions and ensure that your funds land in an active state, please contact your Rhino.fi Customer Success Manager or speak to a member of the Rhino.fi sales team.

tokenOut
string

The token that is to be received on the destinationChain, e.g. "USDT".

Minimum string length: 1
bridgeIfNotSwappable
boolean

If true, deposited tokens that cannot be swapped to the tokenOut will be bridged instead of causing a failed transaction. If false, any deposited tokens that cannot be swapped to the tokenOut will cause the transaction to fail. Must be used in conjunction with the tokenOut parameter, e.g. "true".

Response

Success

depositChain
string
required

The blockchain that the Smart Deposit Address is on and that deposits should be sent to, e.g. "ETHEREUM".

Minimum string length: 1
depositAddress
string
required

The Rhino.fi Smart Deposit Address that the deposit has been sent to.

Minimum string length: 1
destinationChain
string
required

The blockchain that the received tokens will be bridged to.

Minimum string length: 1
supportedTokens
object[]
required

The assets that can be deposited to the depositAddress for this depositChain.

isActive
boolean
required

Whether the Smart Deposit Address is being actively monitored for incoming deposits of supportedTokens (true), in which case it will take the necessary bridge / bridge and swap actions, or is not currently being monitored or actioned by Rhino.fi (false). All Smart Deposit Addresses are set to isActive = true when generated and will be monitored and actioned for 10 years, however Smart Deposit Addresses can be disabled via request.

isPaused
boolean
required

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

destinationAddress
string

The blockchain address that the received tokens will be bridged / bridged and swapped to.

Minimum string length: 1
addressNote
string

A note or label for the deposit address as a reference.

Maximum string length: 80
postBridgeData
object

Custom Routing Rules as configured by Rhino.fi for specific clients, e.g. to move funds after the initial bridge into a yield bearing vault. To understand more about how Routing Rules can help automate onchain actions and ensure that your funds land in an active state, please contact your Rhino.fi Customer Success Manager or speak to a member of the Rhino.fi sales team.

tokenOut
string

The token that will be received on the destinationChain.

refundAddress
string

The address that any funds would be returned to in the case that a transaction to this Smart Deposit Address is unsuccessful.

Minimum string length: 1
bridgeIfNotSwappable
boolean

If true, deposited tokens that cannot be swapped to the tokenOut will be bridged instead of causing a failed transaction. If false, any deposited tokens that cannot be swapped to the tokenOut will cause the transaction to fail. Must be used in conjunction with the tokenOut parameter.

chainMetadata
object

Optional chain-specific metadata. Currently only populated for Stellar SDAs, where it exposes the base address and memo id that the muxed deposit address resolves to.