Struct Bolt12Payment

pub struct Bolt12Payment { /* private fields */ }

A payment handler allowing to create and pay BOLT 12 offers and refunds.

Should be retrieved by calling Node::bolt12_payment.

Implementations

impl Bolt12Payment

pub fn send( &self, offer: &Offer, quantity: Option<u64>, payer_note: Option<String>, ) -> Result<PaymentId, Error>

Send a payment given an offer.

If payer_note is Some it will be seen by the recipient and reflected back in the invoice response.

If quantity is Some it represents the number of items requested.

pub fn send_using_amount( &self, offer: &Offer, amount_msat: u64, quantity: Option<u64>, payer_note: Option<String>, ) -> Result<PaymentId, Error>

Send a payment given an offer and an amount in millisatoshi.

This will fail if the amount given is less than the value required by the given offer.

This can be used to pay a so-called “zero-amount” offers, i.e., an offer that leaves the amount paid to be determined by the user.

If payer_note is Some it will be seen by the recipient and reflected back in the invoice response.

pub fn receive( &self, amount_msat: u64, description: &str, expiry_secs: Option<u32>, quantity: Option<u64>, ) -> Result<Offer, Error>

Returns a payable offer that can be used to request and receive a payment of the amount given.

pub fn receive_variable_amount( &self, description: &str, expiry_secs: Option<u32>, ) -> Result<Offer, Error>

Returns a payable offer that can be used to request and receive a payment for which the amount is to be determined by the user, also known as a “zero-amount” offer.

pub fn request_refund_payment( &self, refund: &Refund, ) -> Result<Bolt12Invoice, Error>

Requests a refund payment for the given Refund.

The returned Bolt12Invoice is for informational purposes only (i.e., isn’t needed to retrieve the refund).

pub fn initiate_refund( &self, amount_msat: u64, expiry_secs: u32, quantity: Option<u64>, payer_note: Option<String>, ) -> Result<Refund, Error>

Returns a Refund object that can be used to offer a refund payment of the amount given.