2019-08-31 13:30:56 +01:00
lightning-waitanyinvoice -- Command for waiting for payments
============================================================
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
2022-01-26 17:18:49 +00:00
**waitanyinvoice** [*lastpay\_index*] [*timeout*]
2019-08-10 00:54:18 +01:00
DESCRIPTION
-----------
The **waitanyinvoice** RPC command waits until an invoice is paid, then
returns a single entry as per **listinvoice** . It will not return for
any invoices paid prior to or including the *lastpay\_index* .
This is usually called iteratively: once with no arguments, then
repeatedly with the returned *pay\_index* entry. This ensures that no
paid invoice is missed.
The *pay\_index* is a monotonically-increasing number assigned to an
invoice when it gets paid. The first valid *pay\_index* is 1; specifying
*lastpay\_index* of 0 equivalent to not specifying a *lastpay\_index* .
Negative *lastpay\_index* is invalid.
2020-01-28 01:30:00 +00:00
If *timeout* is specified, wait at most that number of seconds, which
must be an integer.
If the specified *timeout* is reached, this command will return with an
error.
You can specify this to 0 so that **waitanyinvoice** will return
immediately with an error if no pending invoice is available yet.
If unspecified, this command will wait indefinitely.
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
2022-09-05 22:33:09 +01:00
2021-06-16 02:10:17 +01:00
- **label** (string): unique label supplied at invoice creation
- **description** (string): description used in the invoice
2023-01-30 06:24:16 +00:00
- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment
2021-06-16 02:10:17 +01:00
- **status** (string): Whether it's paid or expired (one of "paid", "expired")
2022-09-05 22:45:06 +01:00
- **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable
2023-07-22 11:59:17 +01:00
- **created\_index** (u64): 1-based index indicating order this invoice was created in *(added v23.08)*
2022-09-05 22:45:06 +01:00
- **amount\_msat** (msat, optional): the amount required to pay this invoice
2021-06-16 02:10:17 +01:00
- **bolt11** (string, optional): the BOLT11 string (always present unless *bolt12* is)
- **bolt12** (string, optional): the BOLT12 string (always present unless *bolt11* is)
2023-07-22 11:59:17 +01:00
- **updated\_index** (u64, optional): 1-based index indicating order this invoice was changed (only present if it has changed since creation) *(added v23.08)*
2021-06-16 02:10:17 +01:00
If **status** is "paid":
2022-09-05 22:33:09 +01:00
2022-09-05 22:45:06 +01:00
- **pay\_index** (u64): Unique incrementing index for this payment
2022-11-11 02:03:13 +00:00
- **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat* , since clients may overpay)
2022-09-05 22:45:06 +01:00
- **paid\_at** (u64): UNIX timestamp of when it was paid
2023-01-30 06:24:16 +00:00
- **payment\_preimage** (secret): proof of payment
2023-10-26 04:34:54 +01:00
- **paid\_outpoint** (object, optional): Outpoint this invoice was paid with *(added v23.11)* :
- **txid** (txid): ID of the transaction that paid the invoice *(added v23.11)*
- **outnum** (u32): The 0-based output number of the transaction that paid the invoice *(added v23.11)*
2021-09-03 11:07:59 +01:00
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
2019-08-10 00:54:18 +01:00
2020-01-28 01:30:00 +00:00
Possible errors are:
* 904.
The *timeout* was reached without an invoice being paid.
2019-08-10 00:54:18 +01:00
AUTHOR
------
Rusty Russell < < rusty @ rustcorp . com . au > > is mainly responsible.
SEE ALSO
--------
lightning-waitinvoice(7), lightning-listinvoice(7),
lightning-delinvoice(7), lightning-invoice(7).
RESOURCES
---------
Main web site: < https: / / github . com / ElementsProject / lightning >
2020-08-25 02:33:16 +01:00
2024-01-25 00:28:53 +00:00
[comment]: # ( SHA256STAMP:9e15a21311e8822a4e61a2f47f047caea6a8fa2a65acd1c81854c0c42ea6bba1)