mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-19 05:44:12 +01:00
b0da807700
This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
3.0 KiB
3.0 KiB
lightning-createinvoice -- Low-level invoice creation
SYNOPSIS
createinvoice invstring label preimage
DESCRIPTION
The createinvoice RPC command signs and saves an invoice into the database.
RETURN VALUE
(Note: the return format is the same as lightning-listinvoices(7)).
On success, an object is returned, containing:
- label (string): the label for the invoice
- payment_hash (hash): the hash of the payment_preimage which will prove payment
- status (string): Whether it has been paid, or can no longer be paid (one of "paid", "expired", "unpaid")
- description (string): Description extracted from bolt11 or bolt12
- expires_at (u64): UNIX timestamp of when invoice expires (or expired)
- created_index (u64): 1-based index indicating order this invoice was created in (added v23.08)
- bolt11 (string, optional): the bolt11 string (always present unless bolt12 is)
- bolt12 (string, optional): the bolt12 string instead of bolt11 (experimental-offers only)
- amount_msat (msat, optional): The amount of the invoice (if it has one)
- pay_index (u64, optional): Incrementing id for when this was paid (status paid only)
- amount_received_msat (msat, optional): Amount actually received (status paid only)
- paid_at (u64, optional): UNIX timestamp of when invoice was paid (status paid only)
- paid_outpoint (object, optional): Outpoint this invoice was paid with (status paid only) (added v23.11):
- txid (txid): ID of the transaction that paid the invoice (status paid only) (added v23.11)
- outnum (u32): The 0-based output number of the transaction that paid the invoice (status paid only) (added v23.11)
- payment_preimage (secret, optional): the proof of payment: SHA256 of this payment_hash
- local_offer_id (hex, optional): the id of our offer which created this invoice (experimental-offers only). (always 64 characters)
- invreq_payer_note (string, optional): the optional invreq_payer_note from invoice_request which created this invoice (experimental-offers only).
ERRORS
On failure, an error is returned and no invoice is created. If the lightning process fails before responding, the caller should use lightning-listinvoices(7) to query whether this invoice was created or not.
The following error codes may occur:
- -1: Catchall nonspecific error.
- 900: An invoice with the given label already exists.
AUTHOR
Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
SEE ALSO
lightning-invoice(7), lightning-listinvoices(7), lightning-delinvoice(7), lightning-getroute(7), lightning-sendpay(7), lightning-offer(7).
RESOURCES
Main web site: https://github.com/ElementsProject/lightning