Ctrl+K

Withdraw from lightning balance

post/api/v2/wallet/{walletId}/lightning/withdrawal

This API call is used to request a withdrawal of on-chain funds from the custodial lightning balance. Withdrawals are deducted from the wallet's lightning balance.

Path Parameters

  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

value number required
The amount to withdraw denominated in satoshis
Example: 50000000
destination string required
An address that will receive the on-chain funds. This address must belong to the BitGo wallet for which the withdrawal request is being made.
Example: bc1q2la002q4rylgx9luzlv7dyr5ykeh0n46xnf02w
sequenceId string required
Your own unique ID for this withdrawal. This acts as a unique identifier for the withdrawal. Requests with the same values as a previous request will be rejected to prevent duplicate withdrawals.

200 Response

txid string required
The on-chain transaction id of the withdrawal
Example: 10dd35bf2a97388287e156f17f96cddb16e21eb77d1bf2ba2020ef04bee89fd6

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

409 Response

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