Struct WithdrawLnurlRequest

pub struct WithdrawLnurlRequest {
    pub lnurl: Option<String>,
    pub withdraw_request: Option<LnurlWithdrawRequest>,
    pub amount: Option<Amount>,
    pub description: Option<String>,
    pub personal_note: Option<String>,
}

A request to withdraw from an LNURL-withdraw endpoint.

Use analyze to get the associated LnurlWithdrawRequest, which contains information on amount constraints, default description, and more.

Fields

lnurl: Option<String>

The LNURL to withdraw from.

Exactly one of lnurl or withdraw_request should be provided.

withdraw_request: Option<LnurlWithdrawRequest>

The LNURL withdraw request to use.

Exactly one of lnurl or withdraw_request should be provided.

amount: Option<Amount>

The amount to withdraw. This value must satisfy the minimum and maximum limits set by the LNURL endpoint.

If None, the maximum amount will be withdrawn.

description: Option<String>

An optional description to encode into the withdrawal invoice, visible to the LNURL endpoint.

If None, the description encoded will be the default description specified by the LNURL endpoint, if any.

personal_note: Option<String>

An optional personal note for this withdrawal.

The LNURL endpoint will not see this note.

If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.