class Tourmaline::StarTransaction

Overview

Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(id : String, amount : Int32 | Int64, date : Time, nanostar_amount : Int32 | Int64 | Nil = nil, source : Tourmaline::TransactionPartner | Nil = nil, receiver : Tourmaline::TransactionPartner | Nil = nil) #

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

[View source]

Instance Method Detail

def amount : Int32 | Int64 #

Integer amount of Telegram Stars transferred by the transaction


[View source]
def amount=(amount : Int32 | Int64) #

Integer amount of Telegram Stars transferred by the transaction


[View source]
def date : Time #

Date the transaction was created in Unix time


[View source]
def date=(date : Time) #

Date the transaction was created in Unix time


[View source]
def id : String #

Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.


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

Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.


[View source]
def nanostar_amount : Int32 | Int64 | Nil #

Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999


[View source]
def nanostar_amount=(nanostar_amount : Int32 | Int64 | Nil) #

Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999


[View source]
def receiver : Tourmaline::TransactionPartner | Nil #

Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions


[View source]
def receiver=(receiver : Tourmaline::TransactionPartner | Nil) #

Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions


[View source]
def source : Tourmaline::TransactionPartner | Nil #

Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions


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

Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions


[View source]