79 lines
2.3 KiB
Groff
79 lines
2.3 KiB
Groff
.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
|
|
|
|
Note that the returned array is ordered by increasing \fIid\fR\.
|
|
|
|
|
|
On success, an object containing \fBpayments\fR is returned\. It is an array of objects, where each object contains:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBid\fR (u64): unique ID for this payment attempt
|
|
.IP \[bu]
|
|
\fBpayment_hash\fR (hex): the hash of the \fIpayment_preimage\fR which will prove payment (always 64 characters)
|
|
.IP \[bu]
|
|
\fBstatus\fR (string): status of the payment (one of "pending", "failed", "complete")
|
|
.IP \[bu]
|
|
\fBcreated_at\fR (u64): the UNIX timestamp showing when this payment was initiated
|
|
.IP \[bu]
|
|
\fBamount_sent_msat\fR (msat): The amount sent
|
|
.IP \[bu]
|
|
\fBamount_msat\fR (msat, optional): The amount delivered to destination (if known)
|
|
.IP \[bu]
|
|
\fBdestination\fR (pubkey, optional): the final destination of the payment if known
|
|
.IP \[bu]
|
|
\fBlabel\fR (string, optional): the label, if given to sendpay
|
|
.IP \[bu]
|
|
\fBbolt11\fR (string, optional): the bolt11 string (if pay supplied one)
|
|
.IP \[bu]
|
|
\fBbolt12\fR (string, optional): the bolt12 string (if supplied for pay: \fBexperimental-offers\fR only)\.
|
|
|
|
.RE
|
|
|
|
If \fBstatus\fR is "complete":
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBpayment_preimage\fR (hex): the proof of payment: SHA256 of this \fBpayment_hash\fR (always 64 characters)
|
|
|
|
.RE
|
|
|
|
If \fBstatus\fR is "failed":
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBerroronion\fR (hex, optional): the onion message returned
|
|
|
|
.RE
|
|
.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
|
|
|
|
\" SHA256STAMP:fa256733033686f8fd53735ba69f34b3fd72c463577e3ad1dfa942662638e42e
|