Package io.github.natanimn.telebof.types.payments

Class StarTransaction

java.lang.Object

io.github.natanimn.telebof.types.payments.StarTransaction

public class StarTransaction
extends Object

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.

Since:

March 3, 2025

Author:

Natanim

Field Summary

Fields

Modifier and Type	Field	Description
private Integer	amount	Integer amount of Telegram Stars transferred by the transaction
private Integer	date	Date the transaction was created in Unix time
private String	id	Unique identifier of the transaction.
private Integer	nanostarAmount	The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999
private TransactionPartner	receiver	Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal).
private TransactionPartner	source	Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal).

Constructor Summary

Constructors

Constructor	Description
StarTransaction()

Method Summary

Modifier and Type	Method	Description
Integer	getAmount()
Integer	getDate()
String	getId()
Integer	getNanostarAmount()
TransactionPartner	getReceiver()
TransactionPartner	getSource()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

private String id

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.

amount

private Integer amount

Integer amount of Telegram Stars transferred by the transaction

date

private Integer date

Date the transaction was created in Unix time

source

private TransactionPartner source

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

receiver

private TransactionPartner receiver

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

nanostarAmount

@SerializedName("nanostar_amount")
private Integer nanostarAmount

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

Constructor Details

StarTransaction

public StarTransaction()

Method Details

getId

public String getId()

getAmount

public Integer getAmount()

getDate

public Integer getDate()

getSource

public TransactionPartner getSource()

getReceiver

public TransactionPartner getReceiver()

getNanostarAmount

public Integer getNanostarAmount()