RefundedPayment

class telegram.RefundedPayment(currency, total_amount, invoice_payload, telegram_payment_charge_id, provider_payment_charge_id=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

This object contains basic information about a refunded 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 is equal.

Available In

telegram.Message.refunded_payment

Added in version 21.4.

Parameters:

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

  • total_amount (int) – Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_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, optional) – Provider payment identifier.

currency[source]

Three-letter ISO 4217 currency code, or XTR for payments in Telegram Stars. Currently, always XTR.

Type:

str

total_amount[source]

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

Type:

int

invoice_payload[source]

Bot-specified invoice payload.

Type:

str

telegram_payment_charge_id[source]

Telegram payment identifier.

Type:

str

provider_payment_charge_id[source]

Optional. Provider payment identifier.

Type:

str