Sending Requests

This documentation uses a JSON body as the default.

Request Formats
Form Data
If no Content-Type is specified, the request will be interpreted as Form Data. Example invoice generation request.
curl
curl
$ curl -u pak_O0iUMxk8kK_qUzkT4YKFvp1ZsUtp: \
-X POST \
-d num_satoshis=20 \
-d memo="Test invoice from the docs" \
https://api.lnpay.co/v1/user/wallet/wi_skllxCQI7yurKi0NCCTc0wwO/invoice
JSON
JSON requests MUST contain the Content-Type: application/json header. Example invoice generation request. 
curl
curl
$ curl -u pak_O0iUMxk8kK_qUzkT4YKFvp1ZsUtp: \
-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_skllxCQI7yurKi0NCCTc0wwO/invoice
Limit response sizes
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
$ curl -u pak_O0iUMxk8kK_qUzkT4YKFvp1ZsUtp: \
https://api.lnpay.co/v1/lntx/lntx_82yveCX2Wn0EkkdyzvyBv?fields=num_satoshis,settled
​
//Response
​
{"num_satoshis":5,"settled":1}

Basics - Previous

How to Authenticate

Next - Basics

Error Handling

Last updated 1 month ago