mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
73 lines
1.6 KiB
Groff
Generated
73 lines
1.6 KiB
Groff
Generated
.TH "LIGHTNING-LISTSENDPAYS" "7" "" "" "lightning-listsendpays"
|
|
.SH NAME
|
|
lightning-listsendpays - Low-level command for querying sendpay status
|
|
.SH SYNOPSIS
|
|
|
|
\fBlistsendpays\fR [\fIbolt11\fR] [\fIpayment_hash\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBlistsendpays\fR RPC command gets the status of all \fIsendpay\fR
|
|
commands (which is also used by the \fIpay\fR command), or with \fIbolt11\fR or
|
|
\fIpayment_hash\fR limits results to that specific payment\. You cannot
|
|
specify both\.
|
|
|
|
|
|
Note that in future there may be more than one concurrent \fIsendpay\fR
|
|
command per \fIpay\fR, so this command should be used with caution\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an array of objects is returned\. Each object contains:
|
|
|
|
|
|
\fIid\fR
|
|
unique internal value assigned at creation
|
|
|
|
|
|
\fIpayment_hash\fR
|
|
the hash of the \fIpayment_preimage\fR which will prove payment\.
|
|
|
|
|
|
\fIdestination\fR
|
|
the final destination of the payment\.
|
|
|
|
|
|
\fIamount_msat\fR
|
|
the amount the destination received, in "NNNmsat" format\.
|
|
|
|
|
|
\fIcreated_at\fR
|
|
the UNIX timestamp showing when this payment was initiated\.
|
|
|
|
|
|
\fIstatus\fR
|
|
one of \fIcomplete\fR, \fIfailed\fR or \fIpending\fR\.
|
|
|
|
|
|
\fIpayment_preimage\fR
|
|
(if \fIstatus\fR is \fIcomplete\fR) proves payment was received\.
|
|
|
|
|
|
\fIlabel\fR
|
|
optional \fIlabel\fR, if provided to \fIsendpay\fR\.
|
|
|
|
|
|
\fIbolt11\fR
|
|
the \fIbolt11\fR argument given to \fIpay\fR (may be missing for pre-0\.7
|
|
payments)\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Christian Decker \fI<decker.christian@gmail.com\fR> is mainly
|
|
responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-listpays\fR(7), \fBlightning-sendpay\fR(7), \fBlightning-listinvoice\fR(7)\.
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|