sideshift_receive
Generate a deposit address to receive cryptocurrency into a local wallet via a SideShift variable-rate shift. Send funds from any wallet to the address for settlement on Bitcoin or Liquid.
Instructions
Receive into the local wallet via a SideShift variable-rate shift. Returns a deposit address on the deposit chain — the user (or external sender) sends to it from any wallet. Settle chain MUST be 'bitcoin' or 'liquid'. Both legs must be in the curated allowlist (USDt on ethereum/tron/bsc/solana/polygon/liquid, or BTC on bitcoin) — mirrors AQUA Flutter's supported pairs. Set SIDESHIFT_ALLOW_ALL_NETWORKS=1 to bypass. STRONGLY RECOMMEND passing external_refund_address (the deposit-side sender's address) so a stuck shift can refund automatically. Also returns qr_code_path: a PNG QR of the deposit address — display it to the user so they can scan it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| settle_coin | Yes | 'btc' or 'usdt' typically | |
| settle_memo | No | ||
| wallet_name | No | default | |
| deposit_coin | Yes | ||
| settle_network | Yes | ||
| deposit_network | Yes | ||
| external_refund_memo | No | ||
| external_refund_address | No | Deposit-chain refund address (strongly recommended) |