peyk.platforms.telegram.types.star_transaction

Classes

StarTransaction(id, amount, date[, ...])

Describes a Telegram Star transaction.

class peyk.platforms.telegram.types.star_transaction.StarTransaction(id: str, amount: int, date: int, nanostar_amount: int | None = None, source: TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerOther | TransactionPartnerAffiliateProgram | TransactionPartnerChat | TransactionPartnerTelegramApi | None = None, receiver: TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerOther | TransactionPartnerAffiliateProgram | TransactionPartnerChat | TransactionPartnerTelegramApi | None = None)

Bases: object

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.

Variables:

• id (str) – Unique identifier of the transaction. Coincides with the identifier 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

• date (int) – Date the transaction was created in Unix time

• nanostar_amount (int | None) – The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999

• source (peyk.platforms.telegram.types.transaction_partner_user.TransactionPartnerUser | peyk.platforms.telegram.types.transaction_partner_fragment.TransactionPartnerFragment | peyk.platforms.telegram.types.transaction_partner_telegram_ads.TransactionPartnerTelegramAds | peyk.platforms.telegram.types.transaction_partner_other.TransactionPartnerOther | peyk.platforms.telegram.types.transaction_partner_affiliate_program.TransactionPartnerAffiliateProgram | peyk.platforms.telegram.types.transaction_partner_chat.TransactionPartnerChat | peyk.platforms.telegram.types.transaction_partner_telegram_api.TransactionPartnerTelegramApi | None) – Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.

• receiver (peyk.platforms.telegram.types.transaction_partner_user.TransactionPartnerUser | peyk.platforms.telegram.types.transaction_partner_fragment.TransactionPartnerFragment | peyk.platforms.telegram.types.transaction_partner_telegram_ads.TransactionPartnerTelegramAds | peyk.platforms.telegram.types.transaction_partner_other.TransactionPartnerOther | peyk.platforms.telegram.types.transaction_partner_affiliate_program.TransactionPartnerAffiliateProgram | peyk.platforms.telegram.types.transaction_partner_chat.TransactionPartnerChat | peyk.platforms.telegram.types.transaction_partner_telegram_api.TransactionPartnerTelegramApi | None) – Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.

id: str

amount: int

date: int

nanostar_amount: int | None = None

source: TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerOther | TransactionPartnerAffiliateProgram | TransactionPartnerChat | TransactionPartnerTelegramApi | None = None

receiver: TransactionPartnerUser | TransactionPartnerFragment | TransactionPartnerTelegramAds | TransactionPartnerOther | TransactionPartnerAffiliateProgram | TransactionPartnerChat | TransactionPartnerTelegramApi | None = None

classmethod from_dict(data: dict | None) → StarTransaction | None

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.