Active Funding (Requires server restart)
checkout.session.completed
invoice.paidpayment_intent.succeededCHECKOUT.ORDER.APPROVEDPAYMENT.CAPTURE.COMPLETEDPAYMENT.SALE.COMPLETEDBILLING.SUBSCRIPTION.PAYMENT.SUCCEEDEDRefresh Interval and History Size are for
historical purposes only.
API URL and JSON Path fields can use the
{to} and {TO} placeholders for the code of the
currency
{TO} is the uppercase code and {to} is the
lowercase code
GET /api/v1/wallet
{"X-Api-Key": ""}{"id": <string>, "name": <string>, "balance":
<int>}
curl api/v1/wallet -H "X-Api-Key:
"
POST /api/v1/payments
{"X-Api-Key": ""}{"out": false, "amount": <int>, "memo": <string>,
"expiry": <int>, "unit": <string>, "webhook":
<url:string>, "internal": <bool>}
{"payment_hash": <string>, "payment_request":
<string>}
curl -X POST api/v1/payments -d
'{"out": false, "amount": <int>, "memo": <string>}' -H
"X-Api-Key:
"
-H "Content-type: application/json"
POST /api/v1/payments (reveal
admin keys
{"X-Api-Key": ""}
{"out": true, "bolt11": <string>}
{"payment_hash": <string>}
curl -X POST api/v1/payments -d
'{"out": true, "bolt11": <string>}' -H "X-Api-Key:
" -H "Content-type: application/json"
POST
/api/v1/payments/decode
{"data": <string>}
curl -X POST api/v1/payments/decode
-d '{"data": <bolt11/lnurl, string>}' -H "Content-type:
application/json"
GET
/api/v1/payments/<payment_hash>
{"X-Api-Key": ""}
{"paid": <bool>}
curl -X GET
api/v1/payments/<payment_hash>
-H "X-Api-Key:
"
-H "Content-type: application/json"
WS
/api/v1/ws/<invoice_key>
wscat -c /
{"balance": <int>, "payment": <object>}
()
Authorization
header.
| Header Name | Header Value |
|---|---|
| Authorization |
Bearer
|
`name` and
`sort description` fields are what the users will
see when browsing the list of extensions.
`id` field is used internally and in the URL
of your extension.
created_at, updated_at and
extra.
Wallet will
be shown.
Currency will
be shown.
Integer and
Float will be shown.
Boolean will
be shown.
is requesting an invoice:
Authenticate with ?
For every website and for every LNbits wallet, a new keypair will be deterministically generated so your identity can't be tied to your LNbits wallet or linked across websites. No other data will be shared with .
Your public key for is:
is requesting
and a
-char comment
is requesting
between
and
and a
-char comment