Skip to main content
Initiates a withdrawal to move funds from the Spark network to an on-chain Bitcoin address via the SparkWallet.

Method Signature

Parameters

string
required
The Bitcoin address where the funds should be sent
ExitSpeed
required
The desired speed of the exit (FAST, MEDIUM, SLOW)
CoopExitFeeQuote
Deprecated. Use feeQuoteId and feeAmountSats instead.
number
The amount in satoshis to withdraw (if not specified, withdraws all available funds)
string
The ID from the fee quote returned by getWithdrawalFeeQuote
number
The fee amount in satoshis based on the chosen exitSpeed
boolean
When true, fees are deducted from withdrawal amount; when false, from remaining wallet balance (default: true)

Returns

CoopExitRequest | null
required
The withdrawal request details, or null if the request cannot be completed

Example