Ctrl+K

Lightning - Withdraw to an onchain address

post/api/v2/{coin}/wallet/{walletId}/lightning/withdraw

Withdraw onchain balance from a lightning wallet to a regular onchain address.

Path Parameters

  • coinstringRequired
    A lightning coin name.
    Example: lnbtc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

passphrase string required
The wallet passphrase.
recipients array[object] required
A list of on-chain recipients with their withdrawal amounts.
amountSat string
The amount to send in satoshis.
address string
The on-chain Bitcoin address of the recipient.
satsPerVbyte string required
The fee rate for the transaction in satoshis per virtual byte.
sequenceId string
Optional sequence ID for the withdrawal transfer.
comment string
Optional comment for the withdrawal transfer.

200 Response

txRequestId string
Transaction request identifier.
txRequestState string
Allowed values: initialized pendingApproval pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend pendingUserSignature pendingDelivery signed delivered canceled rejected failed
pendingApproval object
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string
A cryptocurrency or token ticker symbol.
Example: btc
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
creator string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
createDate string <date-time>
infoAny of
stateAny of
Allowed values: pending awaitingSignature pendingFinalApproval pendingCustodianApproval pendingVideoApproval pendingIdVerification
scope string
What kind of entity the Pending Approval is tied to
Allowed values: enterprise wallet
userIds array[string]
All the Users who should see this Pending Approval
Example: 59cd72485007a239fb00282ed480da1f
approvalsRequired integer
Minimum: >= 1
Example: 1
walletLabel string
resolvers array[object]
addressLabels array[object]
Address labels of recipients in this Pending Approval
withdrawStatus object
The status of the on-chain withdrawal transaction.
status string
State of the withdrawal.
Allowed values: delivered failed
txid string
The transaction ID on the blockchain.
failureReason string
The reason for failure, if any.

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code