class Hamilton::Types::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

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/star_transaction.cr

Constructors

.new(pull : JSON::PullParser)
.new(params)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)
.new(**params)

Instance Method Summary

#amount : Int32
Integer amount of Telegram Stars transferred by the transaction.
#amount=(amount : Int32)
Integer amount of Telegram Stars transferred by the transaction.
#date : Int32
Date the transaction was created in Unix time.
#date=(date : Int32)
Date the transaction was created in Unix time.
#id : String
Unique identifier of the transaction.
#id=(id : String)
Unique identifier of the transaction.
#nanostar_amount : Int32 | Nil
The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999.
#nanostar_amount=(nanostar_amount : Int32 | Nil)
The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#receiver : Hamilton::Types::TransactionPartner | Nil
Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal).
#receiver=(receiver : Hamilton::Types::TransactionPartner | Nil)
Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal).
#source : Hamilton::Types::TransactionPartner | Nil
Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal).
#source=(source : Hamilton::Types::TransactionPartner | Nil)
Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal).

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def amount : Int32 #

Integer amount of Telegram Stars transferred by the transaction.

def amount=(amount : Int32) #

Integer amount of Telegram Stars transferred by the transaction.

def date : Int32 #

Date the transaction was created in Unix time.

def date=(date : Int32) #

Date the transaction was created in Unix time.

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.

def id=(id : String) #

def nanostar_amount : Int32 | Nil #

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

def nanostar_amount=(nanostar_amount : Int32 | Nil) #

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

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def receiver : Hamilton::Types::TransactionPartner | Nil #

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

def receiver=(receiver : Hamilton::Types::TransactionPartner | Nil) #

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

def source : Hamilton::Types::TransactionPartner | Nil #

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

def source=(source : Hamilton::Types::TransactionPartner | Nil) #