package invoicesrpc

Get desktop application:
View/edit binary Protocol Buffers messages

Invoices is a service that can be used to create, accept, settle and cancel invoices.

• rpc SubscribeSingleInvoice (SubscribeSingleInvoiceRequest, stream lnrpc.Invoice)

  lndinvoices.proto:38

  * SubscribeSingleInvoice returns a uni-directional stream (server -> client) to notify the client of state transitions of the specified invoice. Initially the current invoice state is always sent out.

  message SubscribeSingleInvoiceRequest

  lndinvoices.proto:123

  • bytes r_hash = 2

    / Hash corresponding to the (hold) invoice to subscribe to.

• rpc CancelInvoice (CancelInvoiceMsg, CancelInvoiceResp)

  lndinvoices.proto:45

  * CancelInvoice cancels a currently open invoice. If the invoice is already canceled, this call will succeed. If the invoice is already settled, it will fail.

  message CancelInvoiceMsg

  lndinvoices.proto:60

  • bytes payment_hash = 1

    / Hash corresponding to the (hold) invoice to cancel.

  message CancelInvoiceResp

  lndinvoices.proto:64

  (message has no fields)

• rpc AddHoldInvoice (AddHoldInvoiceRequest, AddHoldInvoiceResp)

  lndinvoices.proto:51

  * AddHoldInvoice creates a hold invoice. It ties the invoice to the hash supplied in the request.

  message AddHoldInvoiceRequest

  lndinvoices.proto:66

  • string memo = 1

    * An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.

  • bytes hash = 2

    / The hash of the preimage

  • int64 value = 3

    / The value of this invoice in satoshis

  • bytes description_hash = 4

    * Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request.

  • int64 expiry = 5

    / Payment request expiry time in seconds. Default is 3600 (1 hour).

  • string fallback_addr = 6

    / Fallback on-chain address.

  • uint64 cltv_expiry = 7

    / Delta to use for the time-lock of the CLTV extended to the final hop.

  • repeated lnrpc.RouteHint route_hints = 8

    * Route hints that can each be individually used to assist in reaching the invoice's destination.

  • bool private = 9

    / Whether this invoice should include routing hints for private channels.

  message AddHoldInvoiceResp

  lndinvoices.proto:107

  • string payment_request = 1

    * A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.

• rpc SettleInvoice (SettleInvoiceMsg, SettleInvoiceResp)

  lndinvoices.proto:57

  * SettleInvoice settles an accepted invoice. If the invoice is already settled, this call will succeed.

  message SettleInvoiceMsg

  lndinvoices.proto:116

  • bytes preimage = 1

    / Externally discovered pre-image that should be used to settle the hold invoice.

  message SettleInvoiceResp

  lndinvoices.proto:121

  (message has no fields)