Skip to main content
PATCH
Pause, unpause, or update deposit addresses

Authorizations

Authorization
string
header
required

JWT token for authentication

Path Parameters

depositAddress
required

a string that will be trimmed

Body

application/json
action
object
required

Action to apply to the deposit address(es). "Pause" stops accepting new deposits; "Unpause" resumes; "UpdateDestinationAddressWithSignature" updates the destination address after signature verification and requires custom per-project setup.

Response

Success

depositChain
string
required

The blockchain network identifier where the deposit address is located.

Minimum string length: 1
depositAddress
string
required

The generated deposit address where users should send tokens.

Minimum string length: 1
destinationChain
string
required

The blockchain network identifier where bridged tokens will be sent.

Minimum string length: 1
isActive
boolean
required

Whether this deposit address is currently active and accepting deposits.

isPaused
boolean
required

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

destinationAddress
string

The destination address where bridged tokens will be sent (optional).

Minimum string length: 1
addressNote
string

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

Maximum string length: 80
postBridgeData
object

Optional configuration for post-bridge actions (e.g., staking, lending). Must be omitted if your client does not have PBA enabled. See https://docs.rhino.fi/api-integration/smart-deposits#post-bridge-data for details.

tokenOut
string

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

refundAddress
string

Optional address for refunds if bridging fails.

Minimum string length: 1
bridgeIfNotSwappable
boolean

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

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.