Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 1.64 KB

payments.md

File metadata and controls

43 lines (35 loc) · 1.64 KB
Raw

Please use this documentation for understanding the API params and responses only. For detailed understanding of all aspects, please refer to c-lightning repo or view the help pages on your node.

Help command example: $ lightning-cli help getinfo

Required params are route params. Optional params are query params.

For POST APIs all params will be passed in the body as a JSON

Payments API documentation

Back to Readme

pay

  • Type: POST
  • Sample request URL: https://localhost:3001/v1/pay/
  • Required Params: invoice
  • Optional Params: amount (in msatoshis)
  • Response: "id", "payment_hash", "destination", "msatoshi", "amount_msat", "msatoshi_sent", "amount_sent_msat", "created_at", "status", "payment_preimage", "bolt11"

listpays

  • Type: GET
  • Sample request URL: https://localhost:3001/v1/pay/listPays/
  • Required Params: None
  • Optional Params: invoice
  • Response: "pays" [{ "bolt11", "status", "payment_preimage", "amount_sent_msat" }]

listpayments

  • Type: GET
  • Sample request URL: https://localhost:3001/v1/pay/listPayments/
  • Required Params: None
  • Optional Params: invoice
  • Response: "payments" [{ "id", "payment_hash", "destination", "msatoshi", "amount_msat", "msatoshi_sent", "amount_sent_msat", "created_at", "status", "payment_preimage", "bolt11" }]

decodepay

  • Type: GET
  • Sample request URL: https://localhost:3001/v1/pay/decodePay/
  • Required Params: Bolt11 invoice
  • Optional Params: None
  • Response: "currency", "created_at", "expiry", "payee", "msatoshi", "amount_msat", "description", "min_final_cltv_expiry", "payment_hash", "signature"