API reference / Bitcoin transfers

Get withdrawal

Fetches a bitcoin withdrawal.

View Markdown

GET https://api.bb.no/v1/withdrawals/bitcoin/{withdrawalId}

Authentication

API key

Send x-bb-api-key. No nonce or signature is required.

Authentication guide →

Parameters

withdrawalIdpath · string · required

Responses

200 · OK

application/json

GetBitcoinWithdrawalResponse

Show fields

withdrawalIdstring

Example: "wi_01JA2B3C4D5E6F7G8H9J0K1M2N"

destinationstring

The destination of the withdrawal.

Example: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

networkstring · enum

The network this withdrawal was sent on.

Values: NETWORK_BITCOIN, NETWORK_LIGHTNING

Example: "NETWORK_BITCOIN"

amountBtcnumber · double

The amount of BTC that was withdrawn.

Example: 0.01

amountNoknumber · double

The value of the BTC that was withdrawn, in NOK equivalent at time of withdrawal.

Example: 10480

statusstring · enum

The status of the withdrawal.

Values: WITHDRAWAL_STATUS_PENDING, WITHDRAWAL_STATUS_COMPLETED, WITHDRAWAL_STATUS_FAILED

Example: "WITHDRAWAL_STATUS_COMPLETED"

createdAtstring · date-time

The time the withdrawal was initiated.

Example: "2026-03-14T09:26:53.589793Z"

sentAtstring · date-time

The time the withdrawal was sent from the platform.

Example: "2026-03-14T09:31:07.214552Z"

Request example

GET/v1/withdrawals/bitcoin/{withdrawalId}API key

curl -X GET \
  https://api.bb.no/v1/withdrawals/bitcoin/REPLACE_WITHDRAWALID \
  -H "x-bb-api-key: $BB_API_KEY"

Replace example identifiers and set credentials in environment variables before running.

Response example

Response200

{
  "withdrawalId": "wi_01JA2B3C4D5E6F7G8H9J0K1M2N",
  "destination": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "network": "NETWORK_BITCOIN",
  "amountBtc": 0.01,
  "amountNok": 10480,
  "status": "WITHDRAWAL_STATUS_COMPLETED",
  "createdAt": "2026-03-14T09:26:53.589793Z",
  "sentAt": "2026-03-14T09:31:07.214552Z"
}