mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
bf4d9e30d2
core-lightning/doc/lightning-delinvoice.7.md
Rusty Russell aad4495f56 delinvoice: allow desconly arg to only remove the description. 
Means that field is now optional in JSON output.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: JSON-RPC: `delinvoice` has a new parameter `desconly` to remove description.
2022-03-29 10:04:16 +10:30

2.9 KiB
Raw Blame History

lightning-delinvoice -- Command for removing an invoice (or just its description)

SYNOPSIS

delinvoice label status [desconly]

DESCRIPTION

The delinvoice RPC command removes an invoice with status as given in listinvoices, or with desconly set, removes its description.

The caller should be particularly aware of the error case caused by the status changing just before this command is invoked!

If desconly is set, the invoice is not deleted, but has its description removed (this can save space with very large descriptions, as would be used with lightning-invoice(7) deschashonly.

RETURN VALUE

Note: The return is the same as an object from lightning-listinvoice(7).

On success, an object is returned, containing:

  • label (string): Unique label given at creation time
  • payment_hash (hex): the hash of the payment_preimage which will prove payment (always 64 characters)
  • 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
  • amount_msat (msat, optional): the amount required to pay this invoice
  • description (string, optional): description used in the invoice

If bolt12 is present:

  • local_offer_id (hex, optional): offer for which this invoice was created
  • payer_note (string, optional): the optional payer_note from invoice_request which created this invoice

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)

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.
  • 908: The invoice already has no description, and desconly was set.

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