Node URL: Wallet ID: Admin key:
Invoice/read key:
GET /api/v1/wallet
Headers
{"X-Api-Key": ""}
Returns 200 OK (application/json)
{"id": <string>, "name": <string>, "balance": <int>}
Curl example
curl api/v1/wallet -H "X-Api-Key: "
POST /api/v1/payments
Headers
{"X-Api-Key": ""}
Body (application/json)
{"out": false, "amount": <int>, "memo": <string>, "expiry": <int>, "unit": <string>, "webhook": <url:string>, "internal": <bool>}
Returns 201 CREATED (application/json)
{"payment_hash": <string>, "payment_request": <string>}
Curl example
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 )
Headers
{"X-Api-Key": ""}
Body (application/json)
{"out": true, "bolt11": <string>}
Returns 201 CREATED (application/json)
{"payment_hash": <string>}
Curl example
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
Body (application/json)
{"data": <string>}
Returns 200 (application/json)
Curl example
curl -X POST api/v1/payments/decode -d '{"data": <bolt11/lnurl, string>}' -H "Content-type: application/json"
GET /api/v1/payments/<payment_hash>
Headers
{"X-Api-Key": ""}
Returns 200 OK (application/json)
{"paid": <bool>}
Curl example
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 /
Returns 200 OK (application/json)/payments
{"balance": <int>, "payment": <object>}