Skip to content
Back to top
View this page

# StarTransaction

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

  Bases: `telegram.TelegramObject`

  Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot’s balance. This is outside of Telegram’s control.

  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`) – Integer amount of Telegram Stars transferred by the transaction.

    - nanostar_amount (`int`, optional) –

      The number of `1e-09` shares of Telegram Stars transferred by the transaction; from 0 to `999999999`

      Added in version 21.9.

    - 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

    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

    Integer amount of Telegram Stars transferred by the transaction.

    Type:

      `int`

  nanostar_amount

    Optional. The number of `1e-09` shares of Telegram Stars transferred by the transaction; from 0 to `999999999`

    Added in version 21.9.

    Type:

      `int`

  date

    Date the transaction was created as a datetime object.

    Type:

      `datetime.datetime`

  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

    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)

    See `telegram.TelegramObject.de_json()`.