class Tourmaline::SuccessfulPayment

Overview

This object contains basic information about a successful payment.

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.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) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def currency : String #

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


[View source]
def currency=(currency : String) #

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


[View source]
def invoice_payload : String #

Bot-specified invoice payload


[View source]
def invoice_payload=(invoice_payload : String) #

Bot-specified invoice payload


[View source]
def is_first_recurring=(is_first_recurring : Bool | Nil) #

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


[View source]
def is_first_recurring? : Bool | Nil #

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


[View source]
def is_recurring=(is_recurring : Bool | Nil) #

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


[View source]
def is_recurring? : Bool | Nil #

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


[View source]
def order_info : Tourmaline::OrderInfo | Nil #

Optional. Order information provided by the user


[View source]
def order_info=(order_info : Tourmaline::OrderInfo | Nil) #

Optional. Order information provided by the user


[View source]
def provider_payment_charge_id : String #

Provider payment identifier


[View source]
def provider_payment_charge_id=(provider_payment_charge_id : String) #

Provider payment identifier


[View source]
def shipping_option_id : String | Nil #

Optional. Identifier of the shipping option chosen by the user


[View source]
def shipping_option_id=(shipping_option_id : String | Nil) #

Optional. Identifier of the shipping option chosen by the user


[View source]
def subscription_expiration_date : Time | Nil #

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


[View source]
def subscription_expiration_date=(subscription_expiration_date : Time | Nil) #

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


[View source]
def telegram_payment_charge_id : String #

Telegram payment identifier


[View source]
def telegram_payment_charge_id=(telegram_payment_charge_id : String) #

Telegram payment identifier


[View source]
def 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).


[View source]
def 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).


[View source]