61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
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
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
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":
|
|
|
|
- **preimage** (secret): proof of payment
|
|
- **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>
|
|
|
|
[comment]: # ( SHA256STAMP:716bcbf01d946c6e4da0bd2f6817c34e6471a1fcd2f0f388ce47984271285c72)
|