class Hamilton::Types::SuccessfulPayment

Overview

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.

Included Modules

Defined in:

types/successful_payment.cr

Constructors

Instance Method Summary

Instance methods inherited from class Reference

==(other : Hamilton::Any) ==

Instance methods inherited from class Object

===(other : Hamilton::Any) ===

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 currency : String #

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.


def currency=(currency : String) #

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.


def invoice_payload : String #

Bot-specified invoice payload.


def invoice_payload=(invoice_payload : String) #

Bot-specified invoice payload.


def is_first_recurring : Bool | Nil #

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


def is_first_recurring=(is_first_recurring : Bool | Nil) #

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


def is_recurring : Bool | Nil #

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


def is_recurring=(is_recurring : Bool | Nil) #

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


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 order_info : Hamilton::Types::OrderInfo #

Order information provided by the user.


def order_info=(order_info : Hamilton::Types::OrderInfo) #

Order information provided by the user.


def provider_payment_charge_id : String #

Provider payment identifier.


def provider_payment_charge_id=(provider_payment_charge_id : String) #

Provider payment identifier.


def shipping_option_id : String | Nil #

Identifier of the shipping option chosen by the user.


def shipping_option_id=(shipping_option_id : String | Nil) #

Identifier of the shipping option chosen by the user.


def subscription_expiration_date : Int32 | Nil #

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


def subscription_expiration_date=(subscription_expiration_date : Int32 | Nil) #

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


def telegram_payment_charge_id : String #

Telegram payment identifier.


def telegram_payment_charge_id=(telegram_payment_charge_id : String) #

Telegram payment identifier.


def total_amount : Int32 #

Total price in the smallest units of the currency (integer, not float/double)..


def total_amount=(total_amount : Int32) #

Total price in the smallest units of the currency (integer, not float/double)..