Class SuccessfulPayment

java.lang.Object

io.github.natanimn.telebof.types.payments.SuccessfulPayment

All Implemented Interfaces:

Serializable

public class SuccessfulPayment
extends Object
implements Serializable

This class 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.

Since:

3 March 2025

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	currency	Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
String	invoice_payload	Bot-specified invoice payload
Boolean	is_first_recurring	True, if the payment is the first payment for a subscription
Boolean	is_recurring	True, if the payment is a recurring payment for a subscription
OrderInfo	order_info	Order information provided by the user
String	provider_payment_charge_id	Provider payment identifier
String	shipping_option_id	Identifier of the shipping option chosen by the user
Integer	subscription_expiration_date	Expiration date of the subscription, in Unix time; for recurring payments only
String	telegram_payment_charge_id	Telegram payment identifier
Integer	total_amount	Total refunded price in the smallest units of the currency (integer, not float/double).

Constructor Summary

Constructors

Constructor	Description
SuccessfulPayment()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

currency

public String currency

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

total_amount

public Integer total_amount

Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_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)

subscription_expiration_date

public Integer subscription_expiration_date

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

invoice_payload

public String invoice_payload

Bot-specified invoice payload

shipping_option_id

public String shipping_option_id

Identifier of the shipping option chosen by the user

order_info

public OrderInfo order_info

Order information provided by the user

telegram_payment_charge_id

public String telegram_payment_charge_id

Telegram payment identifier

provider_payment_charge_id

public String provider_payment_charge_id

Provider payment identifier

is_recurring

public Boolean is_recurring

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

is_first_recurring

public Boolean is_first_recurring

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

Constructor Details

SuccessfulPayment

public SuccessfulPayment()

Method Details

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object