POST

Lightning - Withdraw to an onchain address

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

Path Params

coin string required

A lightning coin name.
walletId string required

The wallet ID.

matches ^[0-9a-f]{32}$

Body Params

object

passphrase string required

The wallet passphrase.
recipients array of objects required

A list of on-chain recipients with their withdrawal amounts.
recipients object
- amountSat string
  
  The amount to send in satoshis.
- address string
  
  The on-chain Bitcoin address of the recipient.
satsPerVbyte string

Optional fee rate for the transaction in satoshis per virtual byte. Cannot be used with numBlocks.
numBlocks integer

The number of blocks required to confirm a transaction. You can use numBlocks to estimate the fee rate by targeting confirmation within a given number of blocks. If both satsPerVbyte and numBlocks are absent, the transaction defaults to 2 blocks for confirmation.

>= 2 · <= 1000
sequenceId string

Optional sequence ID for the withdrawal transfer.
comment string

Optional comment for the withdrawal transfer.

Responses

200

Response Body

object

txRequestId string

Transaction request identifier.
txRequestState string enum

initializedpendingApprovalpendingUserCommitmentpendingUserRSharependingUserGSharereadyToSendpendingUserSignaturependingDeliverysigneddeliveredcanceledrejectedfailed
pendingApproval object
pendingApproval object
- id string
  
  matches ^[0-9a-f]{32}$
- coin string
  
  A cryptocurrency or token ticker symbol.
- wallet string
  
  matches ^[0-9a-f]{32}$
- enterprise string
  
  matches ^[0-9a-f]{32}$
- organization string
  
  matches ^[0-9a-f]{32}$
- creator string
  
  matches ^[0-9a-f]{32}$
- createDate string date-time
- info object
  ANY OF
  transactionRequest object
  
  transactionRequest object
  
  buildParams object
  
  coinSpecific object
  
  comment string
  
  fee string or integer
  
  isUnsigned boolean
  
  recipients array of objects
  
  recipients object
  
  address string
  
  up to 500 characters
  
  amount string or integer
  
  data string
  
  requestedAmount object
  
  requestedAmount object
  
  Same shape as IntegerOrIntegerString.
  
  sourceWallet string
  
  matches ^[0-9a-f]{32}$
  
  triggeredPolicy string
  
  matches ^[0-9a-f]{32}$
  
  validTransaction string
  
  validTransactionHash string
  
  type string enum
  
  transactionRequest
  transactionRequestFull object
  
  transactionRequestFull object
  
  txRequestId string required
  
  policyUniqueId string
  
  matches ^[0-9a-f]{32}$
  
  verificationItems array of strings
  
  verificationRuleId string
  
  videoApprovers array of strings
  
  walletRebalanceEventId string
  
  matches ^[0-9a-f]{32}$
  
  txRequest object
  
  ANY OF
  
  txRequestId string required
  
  A unique ID for the TxRequest document across all wallets. The combination of the txRequestId and version will always be unique.
  
  version number required
  
  The version of the document. Data changes are done only with inserts and incrementing the version.
  
  latest boolean required
  
  A boolean flag that indicates whether the document is the latest version of the TxRequest.
  
  walletId string required
  
  The id of the Wallet the TxRequest is for.
  
  walletType string enum
  
  The type describes who owns the keys to the wallet associated to the TxRequest.
  
  coldcustodialcustodialPairedhottradingdistributedCustodyadvanced
  
  enterpriseId string
  
  If the wallet that owns the TxRequest is owned by an enterprise then this is the Id of said enterprise.
  
  state string enum required
  
  initializedpendingApprovalpendingUserCommitmentpendingUserRSharependingUserGSharereadyToSendpendingUserSignaturependingDeliverysigneddeliveredcanceledrejectedfailed
  
  date string date-time required
  
  The date and time this version of the TxRequest document was created.
  
  createdDate string date-time required
  
  The date and time the version 1 TxRequest document was created.
  
  userId string required
  
  The Id of the User that produced this version of the TxRequest document. Could have created a new document or updated an existing document.
  
  initiatedBy string required
  
  The Id of the User that originally created the TxRequest document (initiated the TxRequest).
  
  updatedBy string required
  
  The Id of the User that last updated the TxRequest document. This is an alias for the userId field.
  
  intent object required
  
  ANY OF
  
  intentType string required
  
  sequenceId string
  
  A sequenceId is a unique and arbitrary wallet identifier applied to transfers and transactions at creation. It is optional but highly recommended. With a sequenceId you can easily reference transfers and transactions—for example, to safely retry sending. Because BitGo only confirms one send request per sequenceId (and fails all subsequent attempts), you can retry sending without the risk of double spending. The sequenceId is only visible to users on the wallet and is not shared publicly. It is the responsibility of the caller to keep track of this ID.
  
  comment string
  
  The comment is only visible to users on the wallet and is not shared publicly.
  
  nonce string
  
  The 'nonce' of a transaction (optional)
  
  memo string
  
  A memo is an additional address feature necessary for identifying a transaction recipient beyond wallet address.
  
  stakingRequestId string required
  
  intentType string enum required
  
  stake
  
  poolKeyHash string required
  
  The pool key hash to which the coins will be delegated to.
  
  intents array of objects required
  
  intents object
  
  Same shape as TransactionRequestIntent.
  
  pendingApprovalId string
  
  The id of the Pending Approval that was created for the TxRequest if one was required.
  
  isCanceled boolean
  
  True, if the transaction request is canceled.
  
  unsignedTxs array of objects
  
  Holds all unsigned transactions that will be used to fulfill the TxRequest for MPC wallets.
  
  unsignedTxs object
  
  serializedTxHex string required
  
  The unsigned transaction as a hex string.
  
  signableHex string required
  
  The portion of a transaction used to generate a signature (may or may not be the same as serializedTxHex) as a hex string.
  
  derivationPath string
  
  A bip32 path.
  
  feeInfo object
  
  feeInfo object
  
  feeString string required
  
  fee number required
  
  coinSpecific object
  
  Coin specific information.
  
  parsedTx object
  
  The parsed transaction information.
  
  parsedTx object
  
  minerFee string required
  
  spendAmount string
  
  spendAmounts array of objects
  
  spendAmounts object
  
  coinName string
  
  amountString string
  
  payGoFee string
  
  outputs array of objects required
  
  outputs object
  
  address string required
  
  isPayGo boolean
  
  value number
  
  wallet string
  
  walletV1 string
  
  baseAddress string
  
  enterprise string
  
  valueString string required
  
  data string
  
  change boolean
  
  coinName string
  
  inputs array of objects required
  
  inputs object
  
  derivationIndex number
  
  value number required
  
  address string
  
  valueString string required
  
  chain number
  
  index number
  
  type string
  
  memo string
  
  signatureShares array of objects
  
  Only used for MPC coins. This is used to collect signature shares from and exchange them with the user.
  
  signatureShares object
  
  from string enum required
  
  The source of the signature share.
  
  userbackupbitgo
  
  to string enum required
  
  The recipient of the signature share.
  
  userbackupbitgo
  
  share string required
  
  The signature share.
  
  commitmentShares array of objects
  
  Only used for MPC coins on EdDSA curve. This is used to collect commitment shares from and exchange them with the user.
  
  commitmentShares object
  
  from string enum required
  
  The source of the commitment share.
  
  userbackupbitgo
  
  to string enum required
  
  The recipient of the commitment share.
  
  userbackupbitgo
  
  share string required
  
  The commitment share.
  
  type string enum required
  
  The type of the commitment share.
  
  Defaults to commitment
  
  commitment
  
  txHashes array of strings
  
  type string enum
  
  transactionRequestFull
  type string enum
  
  userChangeRequest
  
  userChangeRequest object
  
  userChangeRequest object
  
  action string
  
  permissions string
  
  userChanged string
  
  matches ^[0-9a-f]{32}$
  policyRuleRequest object
  
  policyRuleRequest object
  
  action string
  
  update object
  
  update object
  
  action object
  
  What happens when this rule is triggered
  
  action object
  
  type string enum required
  
  denygetApprovalgetFinalApprovalgetCustodianApprovalgetIdVerification
  
  userIds array of strings
  
  For a final approver action, who can approve
  
  coin string
  
  A cryptocurrency or token ticker symbol.
  
  condition object
  
  condition object
  
  excludeTags array of strings
  
  groupTags array of strings
  
  id string
  
  the id of the rule that is being updated
  
  type string enum
  
  What causes this rule to trigger
  
  advancedWhitelistallTxbitcoinAddressWhitelistcoinAddressWhitelistcoinAddressBlacklisttransactionLimitvelocityLimitwebhook
  
  type string enum
  
  policyRuleRequest
  type string enum
  
  updateApprovalsRequiredRequest
  
  updateApprovalsRequiredRequest object
  
  updateApprovalsRequiredRequest object
  
  requestedApprovalsRequired number
  policyRuleRequest object
  
  policyRuleRequest object
  
  action string
  
  updateEnterpriseRequest object
  
  updateEnterpriseRequest object
  
  type string enum
  
  updateEnterpriseRequest
  
  action string enum
  
  addremove
  
  permission string enum
  
  admin
  
  userId string
  
  email string email
  
  E-Mail address of newly added users
  
  type string enum
  
  policyRuleRequest
  type string enum
  
  enterpriseInviteRequest
  
  enterpriseInviteRequest object
  
  enterpriseInviteRequest object
  
  action string enum
  
  add
  
  email string
  
  The email address of the user being invited
  
  userId string
  
  The ID of the user being invited
  
  isVideoIdUser boolean
  
  enterpriseInfo object
  
  enterpriseInfo object
  
  id string
  
  The ID of the enterprise the user is being invited to
  
  name string
  
  The name of the enterprise the user is being invited to
  
  requiredVerificationStep string
  
  The required verification step needed (if any) before the user can join the enterprise
  
  invitedBy object
  
  invitedBy object
  
  id string
  
  The ID of the user who invited the user
  
  fullName string
  
  The full name of the user who invited the user
  
  email string
  
  The email address of the user who invited the user
- state string
  
  ANY OF
  
  string enum
- scope string enum
  
  What kind of entity the Pending Approval is tied to
  
  enterprisewallet
- userIds array of strings
  
  All the Users who should see this Pending Approval
- approvalsRequired integer
  
  >= 1
- walletLabel string
- resolvers array of objects
  resolvers object
  - user string required
  - date string required
  - resolutionType string enum required
    
    approvedawaitingSignaturependingpendingBitGoAdminApprovalpendingCryptographicApprovalpendingCustodianApprovalpendingFinalApprovalpendingIdVerificationpendingVideoApprovalprocessingrejected
  - signatures array of strings required
  - videoApprover string
  - videoLink string
  - videoException string
- addressLabels array of objects
  addressLabels object
  - address string required
    
    up to 500 characters
  - label string nullable required
    
    A human-readable label for the address.
    
    up to 250 characters
  - walletLabel string
withdrawStatus object

The status of the on-chain withdrawal transaction.
withdrawStatus object
- status string enum
  
  State of the withdrawal.
  
  deliveredfailed
- txid string
  
  The transaction ID on the blockchain.
- failureReason string
  
  The reason for failure, if any.

400

Bad Request

Response Body

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

error string required

Human-readable error message
requestId string required

Client request id
context object required
context object
- id string
  
  matches ^[0-9a-f]{32}$
name string enum required

Error code

InvalidWalletId

curl --request POST \ --url 'http://localhost:3080/api/v2/coin/wallet/walletId/lightning/withdraw' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"passphrase":"string","recipients":[{,"amountSat":"string","address":"string"}],"satsPerVbyte":"string","numBlocks":0,"sequenceId":"string","comment":"string"}'

require 'uri' require 'net/http' url = URI("http://localhost:3080/api/v2/coin/wallet/walletId/lightning/withdraw") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"passphrase":"string","recipients":[{,"amountSat":"string","address":"string"}],"satsPerVbyte":"string","numBlocks":0,"sequenceId":"string","comment":"string"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'http://localhost:3080/api/v2/coin/wallet/walletId/lightning/withdraw', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"passphrase":"string","recipients":[{,"amountSat":"string","address":"string"}],"satsPerVbyte":"string","numBlocks":0,"sequenceId":"string","comment":"string"}', ]); echo $response->getBody();

import requests url = "http://localhost:3080/api/v2/coin/wallet/walletId/lightning/withdraw" payload = {,"passphrase":"string","recipients":[{,"amountSat":"string","address":"string"}],"satsPerVbyte":"string","numBlocks":0,"sequenceId":"string","comment":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)

{ "txRequestId": "string", "txRequestState": "initialized", "pendingApproval": { "id": "59cd72485007a239fb00282ed480da1f", "coin": "btc", "wallet": "59cd72485007a239fb00282ed480da1f", "enterprise": "59cd72485007a239fb00282ed480da1f", "organization": "59cd72485007a239fb00282ed480da1f", "creator": "59cd72485007a239fb00282ed480da1f", "createDate": "string", "info": { "transactionRequest": { "buildParams": {}, "coinSpecific": {}, "comment": "string", "fee": "2000000", "isUnsigned": true, "recipients": [ { "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS", "amount": "2000000", "data": "string" } ], "requestedAmount": "2000000", "sourceWallet": "59cd72485007a239fb00282ed480da1f", "triggeredPolicy": "59cd72485007a239fb00282ed480da1f", "validTransaction": "string", "validTransactionHash": "string" }, "type": "transactionRequest" }, "state": "pending", "scope": "enterprise", "userIds": [ "59cd72485007a239fb00282ed480da1f" ], "approvalsRequired": 1, "walletLabel": "string", "resolvers": [ { "user": "string", "date": "string", "resolutionType": "approved", "signatures": [ "string" ], "videoApprover": "string", "videoLink": "string", "videoException": "string" } ], "addressLabels": [ { "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS", "label": "Bob's Hot Wallet Address", "walletLabel": "My Wallet" } ] }, "withdrawStatus": { "status": "delivered", "txid": "string", "failureReason": "string" } }