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. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<StarTransaction>

Public Attributes
std::string	id { }
	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.
std::int32_t	amount { }
	Integer amount of Telegram Stars transferred by the transaction.
std::optional< std::int32_t >	nanostarAmount { }
	Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999.
std::int32_t	date { }
	Date the transaction was created in Unix time.
std::shared_ptr< TransactionPartner >	source { }
	Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.
std::shared_ptr< TransactionPartner >	receiver { }
	Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.

Detailed Description

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.

Definition at line 13288 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::StarTransaction::Ptr = std::shared_ptr<StarTransaction>

Definition at line 13289 of file Types.h.

Member Data Documentation

◆ amount

std::int32_t TgBot::StarTransaction::amount { }

Integer amount of Telegram Stars transferred by the transaction.

Definition at line 13302 of file Types.h.

◆ date

std::int32_t TgBot::StarTransaction::date { }

Date the transaction was created in Unix time.

Definition at line 13313 of file Types.h.

◆ id

std::string TgBot::StarTransaction::id { }

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.

Definition at line 13297 of file Types.h.

◆ nanostarAmount

std::optional<std::int32_t> TgBot::StarTransaction::nanostarAmount { }

Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999.

Definition at line 13308 of file Types.h.

◆ receiver

std::shared_ptr<TransactionPartner> TgBot::StarTransaction::receiver { }

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

Definition at line 13325 of file Types.h.

◆ source

std::shared_ptr<TransactionPartner> TgBot::StarTransaction::source { }

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

Definition at line 13319 of file Types.h.

The documentation for this struct was generated from the following file:

include/tgbot/Types.h

Public Types

Public Attributes