mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-19 23:24:27 +01:00
b9ac032329
The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
lightning-listinvoices -- Command for querying invoice status
|
|
=============================================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**listinvoices** \[*label*\]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The **listinvoices** RPC command gets the status of a specific invoice,
|
|
if it exists, or the status of all invoices if given no argument.
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
On success, an array *invoices* of objects is returned. Each object contains
|
|
*label*, *payment\_hash*, *status* (one of *unpaid*, *paid* or *expired*),
|
|
*payment\_preimage* (for paid invoices), and *expiry\_time* (a UNIX
|
|
timestamp). If the *msatoshi* argument to lightning-invoice(7) was not "any",
|
|
there will be an *msatoshi* field as a number, and *amount\_msat* as the same
|
|
number ending in *msat*. If the invoice *status* is *paid*, there will be a
|
|
*pay\_index* field and an *msatoshi\_received* field (which may be slightly
|
|
greater than *msatoshi* as some overpaying is permitted to allow clients to
|
|
obscure payment paths); there will also be an *amount\_received\_msat* field
|
|
with the same number as *msatoshi\_received* but ending in *msat*.
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
lightning-waitinvoice(7), lightning-delinvoice(7), lightning-invoice(7).
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|