Skip to content

GramIO API Reference / gramio/dist / TelegramStarTransaction

Interface: TelegramStarTransaction

Defined in: @gramio/types/out/objects.d.ts:8435

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.

Documentation

Properties

PropertyTypeDescriptionDefined in
amountnumberInteger amount of Telegram Stars transferred by the transaction@gramio/types/out/objects.d.ts:8443
datenumberDate the transaction was created in Unix time@gramio/types/out/objects.d.ts:8451
idstringUnique 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.@gramio/types/out/objects.d.ts:8439
nanostar_amount?numberOptional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999@gramio/types/out/objects.d.ts:8447
receiver?TelegramTransactionPartnerOptional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions@gramio/types/out/objects.d.ts:8459
source?TelegramTransactionPartnerOptional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions@gramio/types/out/objects.d.ts:8455