peyk.platforms.telegram.types.successful_payment

Classes

SuccessfulPayment(currency, total_amount, ...)

This object contains basic information about a successful payment.
class peyk.platforms.telegram.types.successful_payment.SuccessfulPayment(currency: str, total_amount: int, invoice_payload: str, telegram_payment_charge_id: str, provider_payment_charge_id: str, subscription_expiration_date: int | None = None, is_recurring: bool | None = None, is_first_recurring: bool | None = None, shipping_option_id: str | None = None, order_info: OrderInfo | None = None)[source]

Bases: object

This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram’s control.

Variables:

  • currency (str) – Three-letter ISO 4217 currency code, or ‘XTR’ for payments in Telegram Stars

  • total_amount (int) – 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).

  • invoice_payload (str) – Bot-specified invoice payload

  • telegram_payment_charge_id (str) – Telegram payment identifier

  • provider_payment_charge_id (str) – Provider payment identifier

  • subscription_expiration_date (int | None) – Expiration date of the subscription, in Unix time; for recurring payments only

  • is_recurring (bool | None) – True, if the payment is a recurring payment for a subscription

  • is_first_recurring (bool | None) – True, if the payment is the first payment for a subscription

  • shipping_option_id (str | None) – Identifier of the shipping option chosen by the user

  • order_info (peyk.platforms.telegram.types.order_info.OrderInfo | None) – Order information provided by the user

currency: str
total_amount: int
invoice_payload: str
telegram_payment_charge_id: str
provider_payment_charge_id: str
subscription_expiration_date: int | None = None
is_recurring: bool | None = None
is_first_recurring: bool | None = None
shipping_option_id: str | None = None
order_info: OrderInfo | None = None
classmethod from_dict(data: dict | None) → SuccessfulPayment | None[source]

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.