tgbot-cpp
Loading...
Searching...
No Matches
TgBot::SuccessfulPayment Class Reference

This object contains basic information about a successful payment. More...

#include <SuccessfulPayment.h>

Public Types

typedef std::shared_ptr< SuccessfulPaymentPtr
 

Public Attributes

std::string currency
 Three-letter ISO 4217 currency code.
 
std::int32_t totalAmount
 Total price in the smallest units of the currency (integer, not float/double).
 
std::string invoicePayload
 Bot specified invoice payload.
 
std::string shippingOptionId
 Optional. Identifier of the shipping option chosen by the user.
 
OrderInfo::Ptr orderInfo
 Optional. Order info 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.

https://core.telegram.org/bots/api#successfulpayment

Definition at line 20 of file SuccessfulPayment.h.

Member Typedef Documentation

◆ Ptr

Definition at line 22 of file SuccessfulPayment.h.

Member Data Documentation

◆ currency

std::string TgBot::SuccessfulPayment::currency

Three-letter ISO 4217 currency code.

Definition at line 27 of file SuccessfulPayment.h.

◆ invoicePayload

std::string TgBot::SuccessfulPayment::invoicePayload

Bot specified invoice payload.

Definition at line 45 of file SuccessfulPayment.h.

◆ orderInfo

OrderInfo::Ptr TgBot::SuccessfulPayment::orderInfo

Optional. Order info provided by the user.

Definition at line 55 of file SuccessfulPayment.h.

◆ providerPaymentChargeId

std::string TgBot::SuccessfulPayment::providerPaymentChargeId

Provider payment identifier.

Definition at line 65 of file SuccessfulPayment.h.

◆ shippingOptionId

std::string TgBot::SuccessfulPayment::shippingOptionId

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

Definition at line 50 of file SuccessfulPayment.h.

◆ telegramPaymentChargeId

std::string TgBot::SuccessfulPayment::telegramPaymentChargeId

Telegram payment identifier.

Definition at line 60 of file SuccessfulPayment.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).

https://core.telegram.org/bots/payments/currencies.json

Definition at line 40 of file SuccessfulPayment.h.


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