Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
amount
integer<int64>
default:12345600
required

Amount in BTC. The precision is 8 decimal places

d_tag_memo
string
default:Payment for order #7890

This will be included in the d-tag. If both d_tag_memo and h_tag_memo are provided, only h_tag will be used

h_tag_memo
string

SHA-256 of the d_tag_memo. If both d_tag_memo and h_tag_memo are provided, only h_tag_memo will be used

expiry_interval
integer
default:4800

The expiry of the invoice in seconds. Default value is 3600 (1 hour)

metadata
string<json>

Set of key-value pairs to attach to the lightning_invoice_bolt11 object

Response

200 - application/json
status
string

success or failure

message
string

Message related to the action

data
string<json>

The lightning invoice bolt11 object