mirror of
https://github.com/aljazceru/lightning.git
synced 2026-01-06 07:34:21 +01:00
docs: Document bolt11 and payment_hash arguments of listinvoices
This commit is contained in:
10
doc/lightning-listinvoices.7
generated
10
doc/lightning-listinvoices.7
generated
@@ -3,13 +3,19 @@
|
||||
lightning-listinvoices - Command for querying invoice status
|
||||
.SH SYNOPSIS
|
||||
|
||||
\fBlistinvoices\fR [\fIlabel\fR]
|
||||
\fBlistinvoices\fR [\fIlabel\fR] [\fIinvstring\fR] [\fIpayment_hash\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
|
||||
The \fBlistinvoices\fR RPC command gets the status of a specific invoice,
|
||||
if it exists, or the status of all invoices if given no argument\.
|
||||
|
||||
|
||||
A specific invoice can be queried by providing either the \fBlabel\fR
|
||||
provided when creating the invoice, the \fBinvstring\fR string representing
|
||||
the invoice, or the \fBpayment_hash\fR of the invoice\. Only one of the
|
||||
query parameters can be used at once\.
|
||||
|
||||
.SH RETURN VALUE
|
||||
|
||||
On success, an array \fIinvoices\fR of objects is returned\. Each object contains
|
||||
@@ -35,4 +41,4 @@ Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
||||
|
||||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||||
|
||||
\" SHA256STAMP:de5a19a60e141b582228650442680a6c966edbab2340894db3b532495c5f462c
|
||||
\" SHA256STAMP:24dc46a53eed1dd689d7fb371a3da52242f306126d54bba3d8c6ba5a75b6b795
|
||||
|
||||
@@ -4,7 +4,7 @@ lightning-listinvoices -- Command for querying invoice status
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
**listinvoices** \[*label*\]
|
||||
**listinvoices** \[*label*\] \[*invstring*\] \[*payment_hash*\]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
@@ -12,6 +12,11 @@ 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.
|
||||
|
||||
A specific invoice can be queried by providing either the `label`
|
||||
provided when creating the invoice, the `invstring` string representing
|
||||
the invoice, or the `payment_hash` of the invoice. Only one of the
|
||||
query parameters can be used at once.
|
||||
|
||||
RETURN VALUE
|
||||
------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user