mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
12dd3a439b
core-lightning/doc/lightning-listpays.7.md
Rusty Russell 6e636a835f tools/fromschema.py: handle deprecated null field, don't create empty lists. 
1. listpeers has a deprecated `"closer": null`, which we need
   to handle in the schema, while trying not to damage our
   documentation too much.

2. Don't print a condition if there are no fields to print.

3. Allow a special "untyped" marker for multifundchannel which returns
   arbitrary JSON in a field.

4. Allow a single field return (for 'stop').

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-25 09:49:33 +09:30

2.0 KiB
Raw Blame History

lightning-listpays -- Command for querying payment status

SYNOPSIS

listpays [bolt11] [payment_hash]

DESCRIPTION

The listpay RPC command gets the status of all pay commands, or a single one if either bolt11 or payment_hash was specified.

RETURN VALUE

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

  • payment_hash (hex): the hash of the payment_preimage which will prove payment (always 64 characters)
  • 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
  • label (string, optional): the label, if given to sendpay
  • bolt11 (string, optional): the bolt11 string (if pay supplied one)
  • bolt12 (string, optional): the bolt12 string (if supplied for pay: experimental-offers only).

If status is "pending" or "complete":

  • amount_sent_msat (msat): the amount we actually sent, including fees
  • amount_msat (msat, optional): the amount the destination received, if known

If status is "complete":

  • preimage (hex): proof of payment (always 64 characters)
  • 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. comment: # (GENERATE-FROM-SCHEMA-END)

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