API Reference
Bitcoin Onchain
Send Bitcoin [POST]

Send Bitcoin

https://sandboxapi.bitnob.co/api/v1/wallets/send_bitcoin (opens in a new tab)

Onchain sending of bitcoin


Priority level is used to detect how long a transaction would take.

After the transaction has been sent successfully, the transaction is sent to the webhook URL set on the dashboard

Response Data

Transaction Object (opens in a new tab) is been returned as a response data.

ParametertypeRequired
satoshis Defaults to 3000
amount to be sent in satoshis
int32
address
Address of receiving party
string
customerEmail
Email of customer performing the transaction
string
description
Description of transaction
string
priorityLevel Defaults to regular
Priority level of the transaction. Options are regular, or high
string

Request

Bitcoin Onchain / Send Bitcoin [POST]
curl --request POST \
     --url https://sandboxapi.bitnob.co/api/v1/wallets/send_bitcoin \
     --header 'Authorization: Bearer API-KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "satoshis": 3000,
  "address": "tb1q9h0yjdupyfpxfjg24rpx755xrplvzd9hz2nj7v",
  "customerEmail": "customer@email.com",
  "description": "string",
  "priorityLevel": "regular"
}
'

Responses

🟢 200 - Result example
{
"status": true,
"message": "Transaction successfully submitted",
"data": {
  "reference": "f34929892acc",
  "description": "lorem ipsum",
  "amount": "1.44",
  "fees": "0",
  "btcFees": "0.0000001",
  "btcAmount": "0.00003",
  "satFees": "10",
  "satAmount": "3000",
  "spotPrice": "47950.95",
  "address": "tb1qxnckwtxw88cznfs2hxgc0789ku2h3h05v62zcr",
  "action": "send_bitcoin",
  "type": "debit",
  "status": "pending",
  "channel": "onchain",
  "hash": null,
  "confirmations": null,
  "paymentRequest": null,
  "invoiceId": null,
  "id": "07f0328d-e4d5-4a29-8b71-f8b797d9666f",
  "createdAt": "2021-09-16T10:10:33.128Z",
  "updatedAt": "2021-09-16T10:10:33.128Z"
}
}
Last updated on