summaryrefslogtreecommitdiff
path: root/include/tgbot/types/SuccessfulPayment.h
blob: 748adeada376ade3f2cc1d590a2f82fee4332996 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#ifndef TGBOT_SUCCESSFULPAYMENT_H
#define TGBOT_SUCCESSFULPAYMENT_H

#include "tgbot/types/OrderInfo.h"

#include <cstdint>
#include <string>
#include <memory>
#include <vector>

namespace TgBot {

/**
 * @brief This object contains basic information about a successful payment.
 *
 * https://core.telegram.org/bots/api#successfulpayment
 *
 * @ingroup types
 */
class SuccessfulPayment {
public:
    typedef std::shared_ptr<SuccessfulPayment> Ptr;

    /**
     * @brief Three-letter ISO 4217 currency code
     */
    std::string currency;

    /**
     * @brief 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
     */
    std::int32_t totalAmount;

    /**
     * @brief Bot specified invoice payload.
     */
    std::string invoicePayload;

    /**
     * @brief Optional. Identifier of the shipping option chosen by the user.
     */
    std::string shippingOptionId;

    /**
     * @brief Optional. Order info provided by the user.
     */
    OrderInfo::Ptr orderInfo;

    /**
     * @brief Telegram payment identifier.
     */
    std::string telegramPaymentChargeId;

    /**
     * @brief Provider payment identifier.
     */
    std::string providerPaymentChargeId;
};
}

#endif //TGBOT_SUCCESSFULPAYMENT_H