Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-LISTINVOICES(7)   lightning-listinvoices   LIGHTNING-LISTINVOICES(7)

NAME
       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  con-
       tains  label,  payment_hash,  status  (one of unpaid, paid or expired),
       payment_preimage	(for paid invoices), and  expiry_time  (a  UNIX	 time-
       stamp).	 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_re-
       ceived_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-in-
       voice(7).

RESOURCES
       Main web	site: https://github.com/ElementsProject/lightning

						     LIGHTNING-LISTINVOICES(7)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | SEE ALSO | RESOURCES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=lightning-listinvoices&sektion=7&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help