InvoiceData

@Serializable
data class InvoiceData(val encodedPaymentRequest: String, val bitcoinNetwork: BitcoinNetwork, val paymentHash: String, val amount: CurrencyAmount, val createdAt: Instant, val expiresAt: Instant, val memo: String? = null) : PaymentRequestData

This object represents the BOLT #11 invoice protocol for Lightning Payments. See https://github.com/lightning/bolts/blob/master/11-payment-encoding.md.

Parameters

paymentHash

The payment hash of this invoice.

amount

The requested amount in this invoice. If it is equal to 0, the sender should choose the amount to send.

createdAt

The date and time when this invoice was created.

expiresAt

The date and time when this invoice will expire.

memo

A short, UTF-8 encoded, description of the purpose of this invoice.

Constructors

Link copied to clipboard
constructor(encodedPaymentRequest: String, bitcoinNetwork: BitcoinNetwork, paymentHash: String, amount: CurrencyAmount, createdAt: Instant, expiresAt: Instant, memo: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
open override val bitcoinNetwork: BitcoinNetwork
Link copied to clipboard
val createdAt: Instant
Link copied to clipboard
open override val encodedPaymentRequest: String
Link copied to clipboard
val expiresAt: Instant
Link copied to clipboard
val memo: String? = null
Link copied to clipboard