API reference / Bitcoin transfers

Get Lightning invoice

Fetches a Lightning invoice.

View Markdown

GET https://api.bb.no/v1/deposit-destinations/bitcoin/invoice/{id}

Authentication

API key

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

OAuth

Send an access token in Authorization: Bearer.

Required scopes:

api:deposits:lightning:read

Authentication guide →

Parameters

idpath · string · required

Can be: 1. Deposit destination ID. Prefix: `ded_`. 2. The Lightning invoice itself.

Responses

200 · OK

application/json

GetLightningInvoiceResponse

Show fields

depositDestinationIdstring

Example: "ded_01JA3QW7E2R9T4Y6V8P0S1D3F5"

invoicestring

Example: "lnbc2500u1pvjluezsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygspp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdq5xysxxatsyp3k7enxv4jsxqzpu9qrsgquk0rl77nj30yxdy8j9vdx85fkpmdla2087ne0xh8nhedh8w27kyke0lp53ut353s06fv3qfegext0eh0ymjpf39tuven09sam30g4vgpfna3rh"

statusstring · enum

Values: INVOICE_STATUS_UNPAID, INVOICE_STATUS_PENDING, INVOICE_STATUS_PAID, INVOICE_STATUS_EXPIRED, INVOICE_STATUS_CANCELED

Example: "INVOICE_STATUS_PAID"

Request example

GET/v1/deposit-destinations/bitcoin/invoice/{id}API key

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

GET/v1/deposit-destinations/bitcoin/invoice/{id}OAuth

curl -X GET \
  https://api.bb.no/v1/deposit-destinations/bitcoin/invoice/REPLACE_ID \
  -H "Authorization: Bearer $BB_TOKEN"

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

Response example

Response200

{
  "depositDestinationId": "ded_01JA3QW7E2R9T4Y6V8P0S1D3F5",
  "invoice": "lnbc2500u1pvjluezsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygspp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdq5xysxxatsyp3k7enxv4jsxqzpu9qrsgquk0rl77nj30yxdy8j9vdx85fkpmdla2087ne0xh8nhedh8w27kyke0lp53ut353s06fv3qfegext0eh0ymjpf39tuven09sam30g4vgpfna3rh",
  "status": "INVOICE_STATUS_PAID"
}