API reference / Bitcoin transfers

Deposit destinations

Fetches bitcoin deposit destinations. These destinations are always valid, and can be used for receiving arbitrary amounts. Onchain addresses are refreshed every time a deposit is made, but all prior generated addresses are still valid.

View Markdown

GET https://api.bb.no/v1/deposit-destinations/bitcoin

Authentication

API key

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

Authentication guide →

Parameters

accountIdquery · string

If empty, the default account is used.

Responses

200 · OK

application/json

DepositDestinationsResponse

Show fields

onchainAddressDepositDestination

Bitcoin address for on-chain deposits to the account.

Example: {"destination":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","network":"NETWORK_BITCOIN"}

DepositDestination

Show fields

destinationstring

Example: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

networkstring · enum

Values: NETWORK_BITCOIN, NETWORK_LIGHTNING

Example: "NETWORK_BITCOIN"

lightningAddressDepositDestination

Lightning address (name@bb.no) that accepts payments of any amount to the account.

Example: {"destination":"aktiv-anker@bb.no","network":"NETWORK_LIGHTNING"}

DepositDestination

Show fields

destinationstring

Example: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

networkstring · enum

Values: NETWORK_BITCOIN, NETWORK_LIGHTNING

Example: "NETWORK_BITCOIN"

lnurlPayDepositDestination

LNURL-pay code that accepts Lightning payments to the account.

Example: {"destination":"LNURL1DP68GURN8GHJ7CTSDYHXYC3WDEHJ7MRFVA58GMNFDENJ7MRWW4EXCTTSV9UN7CTRVDHH2MN584SKXC6LXQC5S526TQE4VW2TFG6Y6VJS8PFRV4PS2U64JD6ZGVN82UM9WG7N2C33VCEKXVN995UXZDRY956XVDNZ95UK2VNR95MKGVTPXP3RXCE5V56KVGK8387","network":"NETWORK_LIGHTNING"}

DepositDestination

Show fields

destinationstring

Example: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

networkstring · enum

Values: NETWORK_BITCOIN, NETWORK_LIGHTNING

Example: "NETWORK_BITCOIN"

Request example

GET/v1/deposit-destinations/bitcoinAPI key

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

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

Response example

Response200

{
  "onchainAddress": {
    "destination": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "network": "NETWORK_BITCOIN"
  },
  "lightningAddress": {
    "destination": "aktiv-anker@bb.no",
    "network": "NETWORK_LIGHTNING"
  },
  "lnurlPay": {
    "destination": "LNURL1DP68GURN8GHJ7CTSDYHXYC3WDEHJ7MRFVA58GMNFDENJ7MRWW4EXCTTSV9UN7CTRVDHH2MN584SKXC6LXQC5S526TQE4VW2TFG6Y6VJS8PFRV4PS2U64JD6ZGVN82UM9WG7N2C33VCEKXVN995UXZDRY956XVDNZ95UK2VNR95MKGVTPXP3RXCE5V56KVGK8387",
    "network": "NETWORK_LIGHTNING"
  }
}