Struct CheckoutPreferences

pub struct CheckoutPreferences { /* private fields */ }

Preferences to create your checkout.

[notification_url] is optional, but highly recommended way to receive payment updates.

[available_payment_methods] is used to restrict payment options, and can be used with the set_available_payment_methods builder.

Implementations

impl CheckoutPreferences

pub fn new( order_number: String, products: Vec<YapayProduct>, ) -> Result<Self, SDKError>

pub fn set_available_payment_methods<PM>(self, methods: &[PM]) -> Self

where PM: AsPaymentMethod,

Restricts payment methods to those used on methods parameter.

Usage

use std::num::NonZeroU8;

use yapay_sdk_rust::checkout::CheckoutPreferences;
use yapay_sdk_rust::common_types::{AsPaymentMethod, PaymentCreditCard, YapayProduct};

let product = YapayProduct::new(
    "sample".to_string(),
    "a sample product".to_string(),
    NonZeroU8(1).unwrap(),
    10_f64,
);

let preferences = CheckoutPreferences::new("order_number".to_string(), vec![product])
    .unwrap()
    .set_available_payment_methods(&[PaymentCreditCard::payment_methods_all()]);

// now you can only pay with credit cards

pub fn set_notification_url<U>(self, url: U) -> Result<Self, SDKError>

where U: IntoUrl,

pub fn set_process_url<U>(self, url: U) -> Result<Self, SDKError>

where U: IntoUrl,

Sets the url_process, which will redirect the user after payment. This is the standard way of redirecting, it doesn’t matter if the transaction failed, or was a success.

You can use this to trigger a response to your server that the user has finished a payment, and now needs to wait for a definitive response.

pub fn to_form(self, token: &str) -> String

Trait Implementations

impl Clone for CheckoutPreferences

fn clone(&self) -> CheckoutPreferences

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckoutPreferences

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

Formats the value using the given formatter.

impl Default for CheckoutPreferences

fn default() -> CheckoutPreferences

Returns the “default value” for a type.

impl PartialEq for CheckoutPreferences

fn eq(&self, other: &CheckoutPreferences) -> 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 CheckoutPreferences

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for CheckoutPreferences

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for CheckoutPreferences

type Args = ()

fn validate_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl StructuralPartialEq for CheckoutPreferences