Sign in
Withdraw

Withdraw BTC

Withdraw BTC to a wallet

post/withdraw/btc

Request body

invoicestring string
memostring string

Example request

{
  "invoice": "lntbs1234567890n1pjnruqtpp5xmrq39nwyhgde4a94wsnuacj4stacls05g4x5du2req9pvjpqz6sdz9296k7ar98gsxgdm9vvmx2v3s95ckyceh956xvd3595uxyetr95cnydrxxv6nvwrxv5mngcqzpuxqzfvsp578t78k4628snkkhc43eqrpn6sem28w4cwgzn7ceyyr320kwm4uss9qyyssqcwxw8wy2qenwgm7gagx9lwvcs9w9tw47ntuc823yclasjqczvvj545hr4d9nmg996l0cswudgeawclwytafmh66a2fafk4heksyae5sq3vzd28",
  "memo": "Withdrawal to wallet"
}

Response

Withdraw response

statusstring string

Example response

{
  "status": "ok",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "ref": "99eeff854ffd345fffs67890",
    "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
    "amount": 1000,
    "autopayout": true,
    "createdAt": "2021-07-01T12:00:00Z",
    "updatedAt": "2021-07-01T12:00:00Z",
    "metadata": {
      "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "orderId": "99854-2345",
      "bankCode": "090267",
      "bankAccountName": "Satoshi Nakamoto",
      "bankAccountNumber": "0123456789",
      "createdAt": "2021-07-01T12:00:00Z",
      "updatedAt": "2021-07-01T12:00:00Z"
    }
  }
}

Changes

Changed in 6 of the 32 revisions of this API.54

  • 842376cab8551See the full diff
    • ●

      added the new USDT enum value to the data/currency response property for the response status 200

      response-property-enum-value-added

  • b1804285e9011See the full diff
    • ●

      added the new GHS enum value to the data/currency response property for the response status 200

      response-property-enum-value-added

  • f3878f3493171See the full diff
    • ○

      removed the TRANSFER enum value from the data/type response property for the response status 200

      response-property-enum-value-removed

  • 7b7e4fa5fe4611See the full diff
    • ●

      removed the optional property data/transactionMetadata from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/metadata to the response with the 200 status

      response-optional-property-added

  • c220a343551221See the full diff
    • ●

      removed the optional property data/transactionMetadata/eProviderRef from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new ZAR enum value to the data/currency response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the USD enum value from the data/currency response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4b09d72f87b21See the full diff
    • ○

      endpoint added

      endpoint-added