Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
wallets

Initiate Bitcoin Lightning Withdrawal

Send funds from a Bitcoin account using the Lightning Network

post/business/send/initiate/lightning

Request body

businessIdstring uuid required

Unique Id of the business who is sending this transactions

sourceAccountIdstring required

The Id of the account to debit

invoicestring invoice required

BOLT11 Invoice

fixedFeestring

Optional fixedFee in Euro cents to override the default application fee configuration. This amount can only be <= the default configured amount for this transaction type.

percentFeeBpsstring

Optional percentage fee in bps to override the default application fee configuration. This amount can only be <= the default configured amount for this transaction type.

Example request

{
  "sourceAccountId": "d3ec681f6f84f404554c44bba797315b",
  "invoice": "lntb5u1p30y64npp5w5lp9v25yz4trdc204l2he262jywaehymnqx0mtel0l6lk3r8m9qdpav4u8getwvssx6et5dphkgmmvdankjetnyp3kc6trddej6ctwvskk6mmjw3shycqzpgxqzjhsp5cnstd43825ttacu682m39d6frdttz7wkucx3lr8je9p2yhtqtvvs9qyyssqr5m7s4x8a9efvumqcynj30jaf05pkd0d7f0a8jplgqqyvg7um8lxqp6y63m7mmvc2qvx93lr0tvvyjarmpapcnfcqaz23as5q8r99sspguqp9z"
}

Response

success

challengeIdstring required
dateExpiresstring date-time required

Example response

{
  "challengeId": "5b7b46ba-8c7a-4df0-8a0e-b46788e9a5d1",
  "dateExpires": "2022-11-10T14:15:49.136Z",
  "feeEstimate": {
    "totalFee": "1000",
    "networkFee": "1000",
    "ourFee": "1000",
    "theirFee": "0",
    "feeCurrency": "BTC",
    "fixedFeeDetails": {
      "amount": "0",
      "exchangeRate": "0"
    },
    "percentageFeeDetails": {
      "amount": "0"
    }
  },
  "transaction": {
    "syncedOwnerId": "f53313fc-09e9-44ae-b5f7-c6a3e20de7f9",
    "parentWalletId": "5a4e08ae-c267-4f16-b86c-4dd7f1d3105e",
    "currency": "BTC",
    "sourceAccountId": "34a5d5af1cd2cf7ceea7882358ad87d6",
    "amount": "100000",
    "invoice": "lntb5u1p30y64npp5w5lp9v25yz4trdc204l2he262jywaehymnqx0mtel0l6lk3r8m9qdpav4u8getwvssx6et5dphkgmmvdankjetnyp3kc6trddej6ctwvskk6mmjw3shycqzpgxqzjhsp5cnstd43825ttacu682m39d6frdttz7wkucx3lr8je9p2yhtqtvvs9qyyssqr5m7s4x8a9efvumqcynj30jaf05pkd0d7f0a8jplgqqyvg7um8lxqp6y63m7mmvc2qvx93lr0tvvyjarmpapcnfcqaz23as5q8r99sspguqp9z",
    "status": "PENDING_2FA_CONFIRMATION",
    "txType": "LN_OUTGOING_INITIATED"
  }
}