forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lightning-listpays.7.txt
49 lines (37 loc) · 1.33 KB
/
lightning-listpays.7.txt
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
LIGHTNING-LISTPAYS(7)
=====================
:doctype: manpage
NAME
----
lightning-listpays - Command for querying payment status
SYNOPSIS
--------
*listpays* [bolt11]
DESCRIPTION
-----------
The *listpay* RPC command gets the status of all 'pay' commands, or a single
one if 'bolt11' is specified.
RETURN VALUE
------------
On success, an array of objects is returned. Each object contains:
'bolt11':: the 'bolt11' argument given to 'pay' (see below for exceptions).
'status':: one of 'complete', 'failed' or 'pending'.
'payment_preimage':: (if 'status' is 'complete') proves payment was received.
'label':: optional 'label', if provided to 'pay'.
'amount_sent_msat':: total amount sent, in "NNNmsat" format.
For old payments (pre-0.7) we didn't save the 'bolt11' string, so in
its place are three other fields:
'payment_hash':: the hash of the 'payment_preimage' which will prove payment.
'destination':: the final destination of the payment.
'amount_msat':: the amount the destination received, in "NNNmsat" format.
These three can all be extracted from 'bolt11', hence are obsolete.
//FIXME:Enumerate errors
AUTHOR
------
Rusty Russell <[email protected]> is mainly responsible.
SEE ALSO
--------
lightning-pay(7), lightning-paystatus(7), lightning-listsendpays(7).
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning