core-lightning/doc/lightning-listinvoice.7.txt

LIGHTNING-LISTINVOICE(7)
========================
:doctype: manpage

NAME
----
lightning-listinvoice - Protocol for querying invoice status

SYNOPSIS
--------
*listinvoice* ['label']

DESCRIPTION
-----------
The *listinvoice* 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, 'complete' (a boolean), and 'expiry_time' (a UNIX timestamp).  If the 'msatoshi' argument to lightning-invoice(7) was not "any", there will be an 'msatoshi' field. If the invoice has been 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).

//FIXME:Enumerate errors

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
doc: manpages for the various lightning RPC calls. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2016-09-06 09:17:41 +02:00			`LIGHTNING-LISTINVOICE(7)`
			`========================`
			`:doctype: manpage`

			`NAME`
			`----`
			`lightning-listinvoice - Protocol for querying invoice status`

			`SYNOPSIS`
			`--------`
			`listinvoice ['label']`

			`DESCRIPTION`
			`-----------`
			`The listinvoice RPC command gets the status of a specific invoice, if`
			`it exists, or the status of all invoices if given no argument.`

			`RETURN VALUE`
			`------------`
invoice: add msatoshi_received field. Paid invoices need to know how much was actually paid: both for the case where no 'msatoshi' amount was specified, and for the normal case, where clients are permitted to overpay in order to help them disguise their payments. While we migrate the db, we leave this field as 0 for old paid invoices. This is unhelpful for accounting, but at least clearly indicates what happened if we find this in the wild. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2018-01-13 12:19:33 +01:00			`On success, an array 'invoices' of objects is returned. Each object contains 'label', 'payment_hash, 'complete' (a boolean), and 'expiry_time' (a UNIX timestamp). If the 'msatoshi' argument to lightning-invoice(7) was not "any", there will be an 'msatoshi' field. If the invoice has been 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).`
doc: manpages for the various lightning RPC calls. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2016-09-06 09:17:41 +02:00
			`//FIXME:Enumerate errors`

			`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`