Sending Requests
This documentation uses a JSON body as the default.
If no
Content-Type is specified, the request will be interpreted as Form Data. Example invoice generation request.curl
$ curl -u sak_XXXXXXX: \
-X POST \
-d num_satoshis=20 \
-d memo="Test invoice from the docs" \
https://api.lnpay.co/v1/user/wallet/wi_XXXXXXX/invoice
JSON requests MUST contain the
Content-Type: application/json header. Example invoice generation request. curl
$ curl -u sak_XXXXXXX: \
-H "Content-Type: application/json" \
-X POST \
-d '{"num_satoshis":20, "memo":"Test invoice from the docs"}' \
https://api.lnpay.co/v1/user/wallet/wi_XXXXXXXX/invoice
By default the objects are returned with all fields. You can limit the response to only the fields you want. You may want to do this if you are dealing with a device that has limited memory or just for speed sake.
curl
$ curl -u sak_XXXXXXX: \
https://api.lnpay.co/v1/lntx/lntx_XXXXXXX?fields=num_satoshis,settled
//Response
{"num_satoshis":5,"settled":1}
Most endpoints support pagination if it is a list-based GET request.
page and per-page are supportedcurl
$ curl -u sak_XXXXXXX: \
https://api.lnpay.co/v1/wallet/wakr_XXXXXX/transactions?page=2&per-page=100
Last modified 2yr ago