GramIO API Reference / gramio/dist / TelegramStarTransaction
Interface: TelegramStarTransaction
Defined in: @gramio/types/out/objects.d.ts:8263
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.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
amount | number | Integer amount of Telegram Stars transferred by the transaction | @gramio/types/out/objects.d.ts:8271 |
date | number | Date the transaction was created in Unix time | @gramio/types/out/objects.d.ts:8279 |
id | string | 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. | @gramio/types/out/objects.d.ts:8267 |
nanostar_amount? | number | Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 | @gramio/types/out/objects.d.ts:8275 |
receiver? | TelegramTransactionPartner | Optional. 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:8287 |
source? | TelegramTransactionPartner | Optional. 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:8283 |