class

Tourmaline::SuccessfulPayment

Inherits JSON::Serializable < Reference < Object

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.

Constructors

new(currency : String, total_amount : Int32 | Int64, invoice_payload : String, telegram_payment_charge_id : String, provider_payment_charge_id : String, subscription_expiration_date : Int32 | Int64 | Nil = nil, is_recurring : Bool | Nil = nil, is_first_recurring : Bool | Nil = nil, shipping_option_id : String | Nil = nil, order_info : Tourmaline::OrderInfo | Nil = nil)
Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

currency

Three-letter ISO 4217 currency code, or "XTR" for payments in Telegram Stars

Source
currency=(currency : String)

Three-letter ISO 4217 currency code, or "XTR" for payments in Telegram Stars

Source
invoice_payload

Bot-specified invoice payload

Source
invoice_payload=(invoice_payload : String)

Bot-specified invoice payload

Source
is_first_recurring=(is_first_recurring : Bool | Nil)

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

Source
is_first_recurring?

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

Source
is_recurring=(is_recurring : Bool | Nil)

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

Source
is_recurring?

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

Source
order_info

Optional. Order information provided by the user

Source
order_info=(order_info : Tourmaline::OrderInfo | Nil)

Optional. Order information provided by the user

Source
provider_payment_charge_id

Provider payment identifier

Source
provider_payment_charge_id=(provider_payment_charge_id : String)

Provider payment identifier

Source
shipping_option_id

Optional. Identifier of the shipping option chosen by the user

Source
shipping_option_id=(shipping_option_id : String | Nil)

Optional. Identifier of the shipping option chosen by the user

Source
subscription_expiration_date

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

Source
subscription_expiration_date=(subscription_expiration_date : Time | Nil)

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

Source
telegram_payment_charge_id

Telegram payment identifier

Source
telegram_payment_charge_id=(telegram_payment_charge_id : String)

Telegram payment identifier

Source
total_amount

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

Source
total_amount=(total_amount : Int32 | Int64)

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

Source