2019-08-31 13:30:56 +01:00
|
|
|
lightning-delinvoice -- Command for removing an invoice
|
|
|
|
|
=======================================================
|
2019-08-10 00:54:18 +01:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
**delinvoice** *label* *status*
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The **delinvoice** RPC command removes an invoice with *status* as given
|
|
|
|
|
in **listinvoices**.
|
|
|
|
|
|
|
|
|
|
The caller should be particularly aware of the error case caused by the
|
|
|
|
|
*status* changing just before this command is invoked!
|
|
|
|
|
|
|
|
|
|
RETURN VALUE
|
|
|
|
|
------------
|
|
|
|
|
|
2021-05-26 06:55:01 +01:00
|
|
|
Note: The return is the same as an object from lightning-listinvoice(7).
|
|
|
|
|
|
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
|
|
|
On success, an object is returned, containing:
|
|
|
|
|
- **label** (string): Unique label given at creation time
|
2021-06-16 02:03:17 +01:00
|
|
|
- **payment_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
|
2021-05-26 06:55:01 +01:00
|
|
|
- **status** (string): State of invoice (one of "paid", "expired", "unpaid")
|
|
|
|
|
- **expires_at** (u64): UNIX timestamp when invoice expires (or expired)
|
|
|
|
|
- **bolt11** (string, optional): BOLT11 string
|
|
|
|
|
- **bolt12** (string, optional): BOLT12 string
|
2021-06-16 02:03:17 +01:00
|
|
|
- **amount_msat** (msat, optional): the amount required to pay this invoice
|
|
|
|
|
- **description** (string, optional): description used in the invoice
|
2021-05-26 06:55:01 +01:00
|
|
|
|
|
|
|
|
If **bolt12** is present:
|
|
|
|
|
- **local_offer_id** (hex, optional): offer for which this invoice was created
|
2021-07-02 01:11:35 +01:00
|
|
|
- **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice
|
2021-05-26 06:55:01 +01:00
|
|
|
|
|
|
|
|
If **status** is "paid":
|
|
|
|
|
- **pay_index** (u64): unique index for this invoice payment
|
|
|
|
|
- **amount_received_msat** (msat): how much was actually received
|
|
|
|
|
- **paid_at** (u64): UNIX timestamp of when payment was received
|
|
|
|
|
- **payment_preimage** (hex): SHA256 of this is the *payment_hash* offered in the invoice (always 64 characters)
|
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
2019-08-10 00:54:18 +01:00
|
|
|
|
2020-07-19 10:04:03 +01:00
|
|
|
ERRORS
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
The following errors may be reported:
|
|
|
|
|
|
|
|
|
|
- -1: Database error.
|
|
|
|
|
- 905: An invoice with that label does not exist.
|
|
|
|
|
- 906: The invoice *status* does not match the parameter.
|
|
|
|
|
An error object will be returned as error *data*, containing
|
|
|
|
|
*current_status* and *expected_status* fields.
|
|
|
|
|
This is most likely due to the *status* of the invoice
|
|
|
|
|
changing just before this command is invoked.
|
|
|
|
|
|
2019-08-10 00:54:18 +01:00
|
|
|
AUTHOR
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
lightning-listinvoice(7), lightning-waitinvoice(7),
|
|
|
|
|
lightning-invoice(7), lightning-delexpiredinvoice(7),
|
|
|
|
|
lightning-autocleaninvoice(7)
|
|
|
|
|
|
|
|
|
|
RESOURCES
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
2020-08-25 02:33:16 +01:00
|
|
|
|
2021-07-02 01:11:35 +01:00
|
|
|
[comment]: # ( SHA256STAMP:65c14a16b939461a06d81b0ff41e976ea4c7bf963cccdeba47739fe9ca1658a1)
|
