Skip to main content
POST
/
api
/
v1
/
lightning
/
receives
/
invoice
Create a BOLT11 invoice
curl --request POST \
  --url https://api.example.com/api/v1/lightning/receives/invoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_sat": 1,
  "description": "<string>"
}
'
{
  "invoice": "<string>"
}

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.

Response

Returns the created invoice

​
invoice
string
required

The invoice string