Hide navigation sidebar
Hide table of contents sidebar
PTB has undergone significant changes in v20. Please read the documentation carefully and also check out the transition guide in the wiki.
Back to top
Toggle table of contents sidebar

# SuccessfulPayment

class telegram.SuccessfulPayment(currency, total_amount, invoice_payload, telegram_payment_charge_id, provider_payment_charge_id, shipping_option_id=None, order_info=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  This object contains basic information about a successful payment.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `telegram_payment_charge_id` and `provider_payment_charge_id` are equal.

  Parameters:

    - currency (`str`) – Three-letter ISO 4217 currency code.

    - 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.

    - shipping_option_id (`str`, optional) – Identifier of the shipping option chosen by the user.

    - order_info (`telegram.OrderInfo`, optional) – Order info provided by the user.

    - telegram_payment_charge_id (`str`) – Telegram payment identifier.

    - provider_payment_charge_id (`str`) – Provider payment identifier.

  currency

    Three-letter ISO 4217 currency code.

    Type:

      `str`

  total_amount

    Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 `amount` is `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).

    Type:

      `int`

  invoice_payload

    Bot specified invoice payload.

    Type:

      `str`

  shipping_option_id

    Optional. Identifier of the shipping option chosen by the user.

    Type:

      `str`

  order_info

    Optional. Order info provided by the user.

    Type:

      `telegram.OrderInfo`

  telegram_payment_charge_id

    Telegram payment identifier.

    Type:

      `str`

  provider_payment_charge_id

    Provider payment identifier.

    Type:

      `str`

  Available In

  `telegram.Message.successful_payment`

  classmethod de_json(data, bot)

    See `telegram.TelegramObject.de_json()`.