Skip to content
Bare BitcoinDevelopers

Search documentation

↑ ↓ Select · Enter Open · Escape Close

barebitcoin.no ↗
Menu
← Models

NewLightningInvoiceRequest

object

View Markdown

Properties

accountIdstring

if empty, the default account is used.

Example: "acc_01HQZX3V9KJ4M2P8R6T0W5Y7BC"

currencystring · enum

The currency the invoice is denominated in. Once created, the invoice is for a specific amount of bitcoin.

Values: CURRENCY_BTC, CURRENCY_NOK

Example: "CURRENCY_NOK"

amountnumber · double

The amount of the invoice, in the requested currency. Setting to 0 creates an invoice where any amount is accepted.

Example: 2620

publicDescriptionstring

Public description of the invoice. The invoice commits to it through its description hash; the memo field is left empty, so most wallets do not show it to the payer.

Example: "Kaffe og kanelbolle"

internalDescriptionstring

Free-form text description of the invoice. Can be used to correlate with your own systems. Only shown to the creator of this invoice, within the Bare Bitcoin systems.

Example: "faktura-1042"

Used by

Create Lightning invoice · request