Struct CheckoutOptions 

pub struct CheckoutOptions {
    pub speed_policy: Option<SpeedPolicy>,
    pub payment_methods: Option<Vec<String>>,
    pub default_payment_method: Option<String>,
    pub expiration_minutes: Option<Box<TimeSpanMinutes>>,
    pub monitoring_minutes: Option<Box<TimeSpanMinutes>>,
    pub payment_tolerance: Option<f64>,
    pub redirect_url: Option<String>,
    pub redirect_automatically: Option<bool>,
    pub requires_refund_email: Option<bool>,
    pub default_language: Option<String>,
}

Fields

speed_policy: Option<SpeedPolicy>

payment_methods: Option<Vec<String>>

A specific set of payment methods to use for this invoice (ie. BTC, BTC-LightningNetwork). By default, select all payment methods enabled in the store.

default_payment_method: Option<String>

Default payment type for the invoice (e.g., BTC, BTC-LightningNetwork). Default payment method set for the store is used if this parameter is not specified.

expiration_minutes: Option<Box<TimeSpanMinutes>>

The number of minutes after which an invoice becomes expired. Defaults to the store’s settings. (The default store settings is 15)

monitoring_minutes: Option<Box<TimeSpanMinutes>>

The number of minutes after an invoice expired after which we are still monitoring for incoming payments. Defaults to the store’s settings. (The default store settings is 1440, 1 day)

payment_tolerance: Option<f64>

A percentage determining whether to count the invoice as paid when the invoice is paid within the specified margin of error. Defaults to the store’s settings. (The default store settings is 100)

redirect_url: Option<String>

When the customer has paid the invoice, the URL where the customer will be redirected when clicking on the return to store button. You can use placeholders {InvoiceId} or {OrderId} in the URL, BTCPay Server will replace those with this invoice id or metadata.orderId respectively.

redirect_automatically: Option<bool>

When the customer has paid the invoice, and a redirectURL is set, the checkout is redirected to redirectURL automatically if redirectAutomatically is true. Defaults to the store’s settings. (The default store settings is false)

requires_refund_email: Option<bool>

Invoice will require user to provide a refund email if this option is set to true. Has no effect if buyerEmail metadata is set as there is no email to collect in this case.

default_language: Option<String>

The language code (eg. en-US, en, fr-FR…) of the language presented to your customer in the checkout page. BTCPay Server tries to match the best language available. If null or not set, will fallback on the store’s default language. You can see the list of language codes with this operation.

Implementations

impl CheckoutOptions

pub fn new() -> CheckoutOptions

Trait Implementations

impl Clone for CheckoutOptions

fn clone(&self) -> CheckoutOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CheckoutOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CheckoutOptions

fn default() -> CheckoutOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CheckoutOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CheckoutOptions

fn eq(&self, other: &CheckoutOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CheckoutOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CheckoutOptions