Struct PayInvoiceRequest

pub struct PayInvoiceRequest {
    pub invoice: Invoice,
    pub fallback_amount: Option<Amount>,
    pub note: Option<String>,
    pub payer_note: Option<String>,
}

A request to pay a BOLT 11 invoice.

Fields

invoice: Invoice

The invoice we want to pay.

fallback_amount: Option<Amount>

Specifies the amount we will pay if the invoice to be paid is amountless. This field must be set if the invoice is amountless.

note: Option<String>

An optional personal note for this payment. The receiver will not see this note. If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.

payer_note: Option<String>

An optional note that was sent to the receiver out-of-band via LNURL-pay that is stored with this outbound payment. Unlike note, this is visible to the recipient. If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.

Trait Implementations

impl<'de> Deserialize<'de> for PayInvoiceRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PayInvoiceRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PayInvoiceRequest> for PayInvoiceRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: PayInvoiceRequest) -> Result<Self>

Performs the conversion.