Struct SuccessfulPayment

pub struct SuccessfulPayment {
    pub currency: String,
    pub invoice_payload: String,
    pub provider_payment_charge_id: String,
    pub telegram_payment_charge_id: String,
    pub total_amount: Integer,
    pub is_first_recurring: Option<bool>,
    pub is_recurring: Option<bool>,
    pub order_info: Option<OrderInfo>,
    pub shipping_option_id: Option<String>,
    pub subscription_expiration_date: Option<Integer>,
}

Represents a successful payment.

Fields

currency: String

Three-letter ISO 4217 currency code.

invoice_payload: String

Bot specified invoice payload.

provider_payment_charge_id: String

Provider payment identifier.

telegram_payment_charge_id: String

Telegram payment identifier.

total_amount: Integer

Total price in the smallest units of the currency (integer, not float/double).

For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

is_first_recurring: Option<bool>

Whether the payment is the first payment for a subscription.

is_recurring: Option<bool>

Whether the payment is a recurring payment for a subscription.

order_info: Option<OrderInfo>

Order info provided by the user.

shipping_option_id: Option<String>

Identifier of the shipping option chosen by the user.

subscription_expiration_date: Option<Integer>

Expiration date of the subscription, in Unix time; for recurring payments only.

Implementations

impl SuccessfulPayment

pub fn new<A, B, C, D>( currency: A, invoice_payload: B, provider_payment_charge_id: C, telegram_payment_charge_id: D, total_amount: Integer, ) -> Self

where A: Into<String>, B: Into<String>, C: Into<String>, D: Into<String>,

Creates a new SuccessfulPayment.

Arguments

• currency - Three-letter ISO 4217 currency code.
• invoice_payload - Bot specified invoice payload.
• provider_payment_charge_id - Provider payment identifier.
• telegram_payment_charge_id - Telegram payment identifier.
• total_amount - Total price.

pub fn with_is_first_recurring(self, value: bool) -> Self

Sets a new value for the is_first_recurring flag.

Arguments

• value - Whether the payment is the first payment for a subscription.

pub fn with_is_recurring(self, value: bool) -> Self

Sets a new value for the is_recurring flag.

Arguments

• value - Whether the payment is a recurring payment for a subscription.

pub fn with_order_info(self, value: OrderInfo) -> Self

Sets a new order info.

Arguments

• value - Order info.

pub fn with_shipping_option_id<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new shipping option ID.

Arguments

• value - Shipping option ID.

pub fn with_subscription_expiration_date(self, value: Integer) -> Self

Sets a new subscription expiration date

Arguments

• value - Expiration date of the subscription, in Unix time; for recurring payments only.

Trait Implementations

impl Clone for SuccessfulPayment

fn clone(&self) -> SuccessfulPayment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SuccessfulPayment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SuccessfulPayment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SuccessfulPayment

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

fn partial_cmp(&self, other: &SuccessfulPayment) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SuccessfulPayment

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 SuccessfulPayment