StarTransaction

class telegram.StarTransaction(id, amount, date, source=None, receiver=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

Describes a Telegram Star transaction.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their id, source, and receiver are equal.

Available In

telegram.StarTransactions.transactions

Added in version 21.4.

Parameters:

  • id (str) – Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.

  • amount (int) – Number of Telegram Stars transferred by the transaction.

  • date (datetime.datetime) – Date the transaction was created as a datetime object.

  • source (telegram.TransactionPartner, optional) – Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.

  • receiver (telegram.TransactionPartner, optional) – Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.

id[source]

Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.

Type:

str

amount[source]

Number of Telegram Stars transferred by the transaction.

Type:

int

date[source]

Date the transaction was created as a datetime object.

Type:

datetime.datetime

source[source]

Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.

Type:

telegram.TransactionPartner

receiver[source]

Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.

Type:

telegram.TransactionPartner

classmethod de_json(data, bot=None)[source]

Converts JSON data to a Telegram object.

Parameters:

  • data (Dict[str, …]) – The JSON data.

  • bot (telegram.Bot, optional) –

    The bot associated with this object. Defaults to None, in which case shortcut methods will not be available.

    Changed in version 21.4: bot is now optional and defaults to None

Returns:

The Telegram object.