.TH "LIGHTNING-LISTPAYS" "7" "" "" "lightning-listpays"
.SH NAME
lightning-listpays - Command for querying payment status
.SH SYNOPSIS

\fBlistpays\fR [bolt11] [payment_hash]

.SH DESCRIPTION

The \fBlistpay\fR RPC command gets the status of all \fIpay\fR commands, or a
single one if either \fIbolt11\fR or \fIpayment_hash\fR was specified\.

.SH RETURN VALUE

On success, an array of objects is returned\. Each object contains:


 \fIbolt11\fR
the \fIbolt11\fR invoice if provided to \fBpay\fR\.


 \fIbolt12\fR
if \fBexperimental-offers\fR is enabled, and \fBpay\fR was a given a bolt12
invoice, this field will appear instead of \fIbolt11\fR\.


 \fIpayment_hash\fR
the \fIpayment_hash\fR of the payment\.


 \fIstatus\fR
one of \fIcomplete\fR, \fIfailed\fR or \fIpending\fR\.


 \fIpayment_preimage\fR
if \fIstatus\fR is \fIcomplete\fR\.


 \fIlabel\fR
optional \fIlabel\fR, if provided to \fIpay\fR or \fIsendonion\fR\.


 \fIamount_sent_msat\fR
total amount sent, in "NNNmsat" format\.


For old payments (pre-0\.7) we didn’t save the \fIbolt11\fR string, so in its
place are three other fields:


 \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\.


These three can all be extracted from \fIbolt11\fR, hence are obsolete\.

.SH AUTHOR

Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.

.SH SEE ALSO

\fBlightning-pay\fR(7), \fBlightning-paystatus\fR(7), \fBlightning-listsendpays\fR(7)\.

.SH RESOURCES

Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

\" SHA256STAMP:5a0e016e18f52ce18484d064c3e659aca2687eeafca4b4365e3037faa1fba53f