Skip to main content
The Auto-Forwarding endpoint configures your sub-account to automatically send received funds for a given asset to a designated external address. This is commonly used to sweep collected deposits into a cold wallet, treasury account, or exchange account without manual intervention. You choose the forwarding frequency: Nightly batches and forwards all accumulated funds once per day, while RealTime forwards each incoming deposit as soon as it is confirmed on-chain.

​
Request

​
string
required
Your Finrock API key.
​
string
required
Your JWT bearer token in the format Bearer {JWT}.
​
string
required
The asset ticker for which to configure auto-forwarding (e.g. BTC, ETH). Use the asset_name value from the Supported Assets list.
​
string
required
The external destination address to which all incoming funds will be forwarded. Validate this address using Validate Address before setting it here.
​
string
default:"Nightly"
Controls how soon after receipt funds are forwarded to the destination address.Allowed values: Nightly, RealTime

​
Example Request

cURL

​
Response

A successful request returns HTTP 200 confirming that auto-forwarding has been configured.
​
string
The asset for which auto-forwarding is now active.
​
string
The external destination address that will receive forwarded funds.
​
string
The configured forwarding frequency (Nightly or RealTime).
​
string
Configuration status. Typical value: active.
Sample 200 Response
​
object
Returned when a required field is missing, the address is invalid, or the asset does not support auto-forwarding.
Sample 400 Response
Updating the auto-forwarding configuration by calling this endpoint again with a different address or frequency replaces the previous setting. Only one active auto-forwarding rule is supported per asset per sub-account.