Struct PayOfferRequest 

pub struct PayOfferRequest {
    pub offer: Offer,
    pub amount: Amount,
    pub client_payment_id: Option<ClientPaymentId>,
    pub message: Option<String>,
    pub personal_note: Option<String>,
}

A request to pay a BOLT 12 offer over Lightning.

Fields

offer: Offer

The offer we want to pay.

amount: Amount

The amount we will pay. If the offer specifies a minimum amount, this value must satisfy that minimum.

client_payment_id: Option<ClientPaymentId>

An optional client-generated ID that also serves as an idempotency key.

Use a fresh ID for each new payment. Reuse the same ID for retries.

If None, each pay_offer will generate a random ID. Separate calls will not be idempotent.

message: Option<String>

An optional message (sent as a BOLT 12 payer_note) included with the invoice request and visible to the recipient. If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.

personal_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.

Trait Implementations

impl<'de> Deserialize<'de> for PayOfferRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PayOfferRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.