home | help 
LIGHTNING-WITHDRAW(7)					   LIGHTNING-WITHDRAW(7)

NAME
     withdraw -- Command for withdrawing funds from the internal wallet

SYNOPSIS
     withdraw destination satoshi [feerate] [minconf] [utxos]

DESCRIPTION
     The  withdraw RPC command sends funds from Core Lightning's internal wallet
     to the address specified in destination.

     *	destination (string): Any Bitcoin accepted type, including bech32.
     *	satoshi (sat_or_all): The amount to be withdrawn from the internal  wal-
	let  (expressed,  as  name  suggests, in satoshi). The string all can be
	used to specify withdrawal of all available funds  (possibly  restricted
	by  the  utxos	parameter, and note that if we have any anchor channels,
	this will always leave at least min-emergency-msat as  change).   Other-
	wise, it is in satoshi precision; it can be a whole number, a whole num-
	ber  ending in sat, a whole number ending in 000msat, or a number with 1
	to 8 decimal places ending in btc.
     *	feerate (feerate, optional): Used for the withdrawal as initial feerate.
	The default is normal.
     *	minconf (u16, optional): Minimum number of confirmations that used  out-
	puts should have. The default is 1.
     *	utxos  (array of outpoints, optional): Specifies the utxos to be used to
	be withdrawn from, as an array of txid:vout. These must  be  drawn  from
	the node's available UTXO set.:
	*  (outpoint, optional)

RETURN VALUE
     On success, an object is returned, containing:

     *	tx (hex): The fully signed bitcoin transaction.
     *	txid (txid): The transaction id of tx.
     *	psbt (string): The PSBT representing the unsigned transaction.

ERRORS
     On failure, an error is reported and the withdrawal transaction is not cre-
     ated.

     *	-1: Catchall nonspecific error.
     *	301:  There are not enough funds in the internal wallet (including fees)
	to create the transaction.
     *	302: The dust limit is not met.
     *	313: The min-emergency-msat reserve not be preserved (and we have anchor
	channels).

AUTHOR
     Felix fixone@gmail.com is mainly responsible.

SEE ALSO
     lightning-listfunds(7),   lightning-fundchannel(7),   lightning-newaddr(7),
     lightning-txprepare(7), lightning-feerates(7)

RESOURCES
     Main web site: https://github.com/ElementsProject/lightning

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli withdraw -k "destination"="bcrt1qcqqv0101010101010101010101010101010101" "satoshi"=555555

     {
       "id": "example:withdraw#1",
       "method": "withdraw",
       "params": {
	 "destination": "bcrt1qcqqv0101010101010101010101010101010101",
	 "satoshi": 555555
       }
     }

     Response:

     {
       "tx": "020000000001wthdrw91000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000",
       "txid": "txidwithdraw2191000910009100091000910009100091000910009100091000",
       "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000"
     }

     Example 2:

     Request:

     $ lightning-cli withdraw -k "destination"="bcrt1phtprcvhz02020202020202020202020202020202020202020202020202" "satoshi"="all" "feerate"="20000perkb" "minconf"=0 "utxos"='["utxo020202020202020202020202020202020202020202020202020202020202:1"]'

     {
       "id": "example:withdraw#2",
       "method": "withdraw",
       "params": {
	 "destination": "bcrt1phtprcvhz02020202020202020202020202020202020202020202020202",
	 "satoshi": "all",
	 "feerate": "20000perkb",
	 "minconf": 0,
	 "utxos": [
	   "utxo020202020202020202020202020202020202020202020202020202020202:1"
	 ]
       }
     }

     Response:

     {
       "tx": "020000000002wthdrw92000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000",
       "txid": "txidwithdraw2292000920009200092000920009200092000920009200092000",
       "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000"
     }

Core Lightning v26.06.1 				   LIGHTNING-WITHDRAW(7)
home | help