Interface Invoice

Hierarchy

  • Invoice

Properties

addIndex: string | number

The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.

amtPaidMsat: string | number

The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.

amtPaidSat: string | number

The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.

creationDate: string | number

When this invoice was created

features: { [key: number]: Feature }

List of features advertised on the invoice.

Type declaration

htlcs: InvoiceHTLC[]

List of HTLCs paying to this invoice [EXPERIMENTAL].

isAmp: boolean

Signals whether or not this is an AMP invoice.

isKeysend: boolean

Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL].

memo: string

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.

paymentRequest: string

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.

private: boolean

Whether this invoice should include routing hints for private channels.

routeHints: RouteHint[]

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

settleDate: string | number

When this invoice was settled

settleIndex: string | number

The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one.

The state the invoice is in.

value: string | number

The value of this invoice in satoshis

The fields value and value_msat are mutually exclusive.

valueMsat: string | number

The value of this invoice in millisatoshis

The fields value and value_msat are mutually exclusive.

Generated using TypeDoc