2019-08-31 13:30:56 +01:00
lightning-listsendpays -- Low-level command for querying sendpay status
=======================================================================
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
2023-10-28 04:10:47 +01:00
**listsendpays** [*bolt11*] [*payment\_hash*] [*status*] [*index* [*start*] [*limit*]]
2019-08-10 00:54:18 +01:00
DESCRIPTION
-----------
The **listsendpays** RPC command gets the status of all *sendpay*
commands (which is also used by the *pay* command), or with *bolt11* or
*payment\_hash* limits results to that specific payment. You cannot
2021-09-17 09:04:17 +01:00
specify both. It is possible filter the payments also by *status* .
2019-08-10 00:54:18 +01:00
2023-10-28 04:10:47 +01:00
Note that there may be more than one concurrent *sendpay*
2019-08-10 00:54:18 +01:00
command per *pay* , so this command should be used with caution.
2023-10-28 04:10:47 +01:00
If neither *bolt11* or *payment\_hash* is specified,
`index` controls ordering, by `created` (default) or `updated` . If
`index` is specified, `start` may be specified to start from that
value, which is generally returned from lightning-wait(7), and `limit`
can be used to specify the maximum number of entries to return.
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
2021-06-16 02:10:17 +01:00
Note that the returned array is ordered by increasing *id* .
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **payments** is returned. It is an array of objects, where each object contains:
2022-09-05 22:33:09 +01:00
2023-10-28 04:09:15 +01:00
- **created\_index** (u64): 1-based index indicating order this payment was created in *(added v23.11)*
- **id** (u64): old synonym for created\_index
2022-11-11 02:03:13 +00:00
- **groupid** (u64): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash
2023-01-30 06:24:16 +00:00
- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment
2021-06-16 02:10:17 +01:00
- **status** (string): status of the payment (one of "pending", "failed", "complete")
2022-09-05 22:45:06 +01:00
- **created\_at** (u64): the UNIX timestamp showing when this payment was initiated
- **amount\_sent\_msat** (msat): The amount sent
2023-01-30 06:09:03 +00:00
- **partid** (u64, optional): Part number (for multiple parts to a single payment)
2023-10-28 04:09:15 +01:00
- **updated\_index** (u64, optional): 1-based index indicating order this payment was changed (only present if it has changed since creation) *(added v23.11)*
2022-09-05 22:45:06 +01:00
- **amount\_msat** (msat, optional): The amount delivered to destination (if known)
2021-06-16 02:10:17 +01:00
- **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)
2022-04-02 03:33:35 +01:00
- **description** (string, optional): the description matching the bolt11 description hash (if pay supplied one)
2021-06-16 02:10:17 +01:00
- **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only).
If **status** is "complete":
2022-09-05 22:33:09 +01:00
2023-01-30 06:24:16 +00:00
- **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash**
2021-06-16 02:10:17 +01:00
If **status** is "failed":
2022-09-05 22:33:09 +01:00
2021-06-16 02:10:17 +01:00
- **erroronion** (hex, optional): the onion message returned
2021-09-03 11:07:59 +01:00
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
2021-01-14 03:36:59 +00:00
2019-08-10 00:54:18 +01:00
AUTHOR
------
Christian Decker < < decker.christian @ gmail . com > > is mainly
responsible.
SEE ALSO
--------
lightning-listpays(7), lightning-sendpay(7), lightning-listinvoice(7).
RESOURCES
---------
Main web site: < https: / / github . com / ElementsProject / lightning >
2020-08-25 02:33:16 +01:00
2023-10-28 04:09:15 +01:00
[comment]: # ( SHA256STAMP:d2c1dbc5953bb86579edf048ee02752d776e763d90729d46339d9a27412d2021)