Skip to main content
POST
Create a BOLT11 invoice

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Body

application/json
amount_sat
integer<int64>
required

The amount to create invoice for (in satoshis). This is the amount the payee will pay but the final amount received by the client will have any server-configured LightningReceiveFees [blocked] deducted.

Required range: x >= 0
description
string | null

Optional description embedded in the invoice as its memo.

token
string | null

Optional lightning receive token for authentication of the claim, if the server requires one and there are no existing spendable VTXOs to prove ownership of.

Response

Returns the created invoice

invoice
string
required

The invoice string