forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlightning-listpays.7
74 lines (37 loc) · 1.49 KB
/
lightning-listpays.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.TH "LIGHTNING-LISTPAYS" "7" "" "" "lightning-listpays"
.SH NAME
lightning-listpays - Command for querying payment status
.SH SYNOPSIS
\fBlistpays\fR [bolt11]
.SH DESCRIPTION
The \fBlistpay\fR RPC command gets the status of all \fIpay\fR commands, or a
single one if \fIbolt11\fR is specified\.
.SH RETURN VALUE
On success, an array of objects is returned\. Each object contains:
\fIbolt11\fR
the \fIbolt11\fR argument given to \fIpay\fR (see below for exceptions)\.
\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 \fIpay\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 \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
.SH SEE ALSO
\fBlightning-pay\fR(7), \fBlightning-paystatus\fR(7), \fBlightning-listsendpays\fR(7)\.
.SH RESOURCES
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL
Last updated 2019-04-30 17:12:10 CEST