2019-08-31 13:30:56 +01:00
lightning-waitinvoice -- Command for waiting for specific payment
=================================================================
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
**waitinvoice** *label*
DESCRIPTION
-----------
The **waitinvoice** RPC command waits until a specific invoice is paid,
then returns that single entry as per **listinvoice** .
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
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-26 12:52:29 +00:00
On error the returned object will contain `code` and `message` properties,
with `code` being one of the following:
2019-08-10 00:54:18 +01:00
2020-01-26 12:52:29 +00:00
- -32602: If the given parameters are wrong.
- -1: If the invoice is deleted while unpaid, or the invoice does not exist.
- 903: If the invoice expires before being paid, or is already expired.
2019-08-10 00:54:18 +01:00
AUTHOR
------
Christian Decker < < decker.christian @ gmail . com > > is mainly
responsible.
SEE ALSO
--------
lightning-waitanyinvoice(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
2023-07-22 11:59:17 +01:00
[comment]: # ( SHA256STAMP:a0ace35f11efcdfbac39ef830cd7b2b6c8f48816c5512d7d2300edb9463aa4e6)