Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateinvoiceResponse

Hierarchy

  • CreateinvoiceResponse

Index

Properties

amount_msat?: number

The amount of the invoice (if it has one)

amount_received_msat?: number

Amount actually received (status paid only)

bolt11?: string

the bolt11 string (always present unless bolt12 is)

bolt12?: string

the bolt12 string instead of bolt11 (experimental-offers only)

description: string

Description extracted from bolt11 or bolt12

expires_at: number

UNIX timestamp of when invoice expires (or expired)

label: string

the label for the invoice

local_offer_id?: string

the id of our offer which created this invoice (experimental-offers only).

paid_at?: number

UNIX timestamp of when invoice was paid (status paid only)

pay_index?: number

Incrementing id for when this was paid (status paid only)

payer_note?: string

the optional payer_note from invoice_request which created this invoice (experimental-offers only).

payment_hash: string

the hash of the payment_preimage which will prove payment

payment_preimage?: string

the proof of payment: SHA256 of this payment_hash

Whether it has been paid, or can no longer be paid

Generated using TypeDoc