SuccessfulPayment#

class pyrogram.types.SuccessfulPayment#

This object contains basic information about a successful payment.

Parameters:

  • 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. Only available to the bot that received the payment.

  • subscription_expiration_date (datetime, optional) – Expiration date of the subscription, in Unix time; for recurring payments only.

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

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

  • shipping_option_id (str, optional) – Identifier of the shipping option chosen by the user. Only available to the bot that received the payment.

  • order_info (OrderInfo, optional) – Order information provided by the user. Only available to the bot that received the payment.

  • telegram_payment_charge_id (str) – Telegram payment identifier. Only available to the bot that received the payment.

  • provider_payment_charge_id (str) – Provider payment identifier. Only available to the bot that received the payment.

  • invoice_name (str, optional) – Name of the invoice; may be empty if unknown