mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
354907c2fd
core-lightning/doc/lightning-listpays.7.md
Christian Decker 7b8ea7f60a msggen: Add two missing fields to the listpays schema 
The fields were missing because they weren't annotated with a type and
a description. Adding those fixes them.

Changelog-Fixed: msggen: `listpays` now includes the missing `amount_msat` and `amount_sent_msat` fields
No-schema-diff-check: fields were always there, just undocumented!
2023-07-27 12:40:28 +09:30

2.3 KiB
Raw Blame History

lightning-listpays -- Command for querying payment status

SYNOPSIS

listpays [bolt11] [payment_hash] [status]

DESCRIPTION

The listpay RPC command gets the status of all pay commands, or a single one if either bolt11 or payment_hash was specified. It is possible filter the payments also by status.

RETURN VALUE

On success, an object containing pays is returned. It is an array of objects, where each object contains:

  • payment_hash (hash): the hash of the payment_preimage which will prove payment
  • status (string): status of the payment (one of "pending", "failed", "complete")
  • created_at (u64): the UNIX timestamp showing when this payment was initiated
  • destination (pubkey, optional): the final destination of the payment if known
  • completed_at (u64, optional): the UNIX timestamp showing when this payment was completed
  • label (string, optional): the label, if given to sendpay
  • bolt11 (string, optional): the bolt11 string (if pay supplied one)
  • description (string, optional): the description matching the bolt11 description hash (if pay supplied one)
  • bolt12 (string, optional): the bolt12 string (if supplied for pay: experimental-offers only).

If status is "complete":

  • amount_sent_msat (msat): The amount of millisatoshi we sent in order to pay (may include fees and not match amount_msat)
  • preimage (secret): proof of payment
  • amount_msat (msat, optional): The amount of millisatoshi we intended to send to the destination
  • number_of_parts (u64, optional): the number of parts for a successful payment (only if more than one).

If status is "failed":

  • erroronion (hex, optional): the error onion returned on failure, if any.

The returned array is ordered by increasing created_at fields.

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.

SEE ALSO

lightning-pay(7), lightning-paystatus(7), lightning-listsendpays(7).

RESOURCES

Main web site: https://github.com/ElementsProject/lightning