API reference

Swagger Docs

Paying an invoice or offer

Send a POST /api/v1/payments request with the wallet's admin key in the X-Api-Key header and a JSON body:

{"out": true, "payment_request": "<BOLT11 invoice>"}

For a BOLT12 offer, also provide the amount in satoshis:

{"out": true, "payment_request": "<BOLT12 offer>", "amount": 21, "unit": "sat"}

The legacy bolt11 input is still accepted. If both payment_request and bolt11 have non-empty values, they must match; conflicting values cause a validation error.


This site uses Just the Docs, a documentation theme for Jekyll.