This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control. More...

#include <Types.h>

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

Public Attributes
std::string	currency { }
	Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.
std::int32_t	totalAmount { }
	Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
std::string	invoicePayload { }
	Bot-specified invoice payload.
std::optional< std::int32_t >	subscriptionExpirationDate { }
	Optional. Expiration date of the subscription, in Unix time; for recurring payments only.
std::optional< bool >	isRecurring { }
	Optional. True, if the payment is a recurring payment for a subscription.
std::optional< bool >	isFirstRecurring { }
	Optional. True, if the payment is the first payment for a subscription.
std::optional< std::string >	shippingOptionId { }
	Optional. Identifier of the shipping option chosen by the user.
std::shared_ptr< OrderInfo >	orderInfo { }
	Optional. Order information provided by the user.
std::string	telegramPaymentChargeId { }
	Telegram payment identifier.
std::string	providerPaymentChargeId { }
	Provider payment identifier.

Detailed Description

This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.

Definition at line 13741 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 13742 of file Types.h.

Member Data Documentation

◆ currency

std::string TgBot::SuccessfulPayment::currency { }

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.

Definition at line 13747 of file Types.h.

◆ invoicePayload

std::string TgBot::SuccessfulPayment::invoicePayload { }

Bot-specified invoice payload.

Definition at line 13760 of file Types.h.

◆ isFirstRecurring

std::optional<bool> TgBot::SuccessfulPayment::isFirstRecurring { }

Optional. True, if the payment is the first payment for a subscription.

Definition at line 13775 of file Types.h.

◆ isRecurring

std::optional<bool> TgBot::SuccessfulPayment::isRecurring { }

Optional. True, if the payment is a recurring payment for a subscription.

Definition at line 13770 of file Types.h.

◆ orderInfo

std::shared_ptr<OrderInfo> TgBot::SuccessfulPayment::orderInfo { }

Optional. Order information provided by the user.

Definition at line 13785 of file Types.h.

◆ providerPaymentChargeId

std::string TgBot::SuccessfulPayment::providerPaymentChargeId { }

Provider payment identifier.

Definition at line 13795 of file Types.h.

◆ shippingOptionId

std::optional<std::string> TgBot::SuccessfulPayment::shippingOptionId { }

Optional. Identifier of the shipping option chosen by the user.

Definition at line 13780 of file Types.h.

◆ subscriptionExpirationDate

std::optional<std::int32_t> TgBot::SuccessfulPayment::subscriptionExpirationDate { }

Optional. Expiration date of the subscription, in Unix time; for recurring payments only.

Definition at line 13765 of file Types.h.

◆ telegramPaymentChargeId

std::string TgBot::SuccessfulPayment::telegramPaymentChargeId { }

Telegram payment identifier.

Definition at line 13790 of file Types.h.

◆ totalAmount

std::int32_t TgBot::SuccessfulPayment::totalAmount { }

Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

Definition at line 13755 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes