Class TransactionPartner

java.lang.Object

io.github.natanimn.telebof.types.payments.TransactionPartner

public class TransactionPartner
extends Object

This class describes the source of a transaction, or its recipient for outgoing transactions.

Since:

3 March 2025

Field Summary

Fields

Modifier and Type	Field	Description
AffiliateInfo	affiliate	Information about the affiliate that received a commission via this transaction.
Chat	chat	Information about the chat
Integer	commission_per_mille	The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users
Gift	gift	The gift sent to the user by the bot; for “gift_purchase” transactions only or The gift sent to the chat by the bot
String	invoice_payload	Bot-specified invoice payload.
List<PaidMedia>	paid_media	Information about the paid media bought by the user; for “paid_media_payment” transactions only
Integer	premium_subscription_duration	Optional.
Integer	request_count	The number of successful requests that exceeded regular limits and were therefore billed
User	sponsor_user	Information about the bot that sponsored the affiliate program
Integer	subscription_period	The duration of the paid subscription.
String	transaction_type	Type of the transaction, currently one of TransactionType.INVOICE_PAYMENT for payments via invoices, TransactionType.PAID_MEDIA_PAYMENT for payments for paid media, TransactionType.GIFT_PURCHASE for gifts sent by the bot, TransactionType.PREMIUM_PURCHASE for Telegram Premium subscriptions gifted by the bot, TransactionType.BUSINESS_ACCOUNT_TRANSFER for direct transfers from managed business accounts
TransactionPartnerType	type	Type of the transaction partner
User	user	Information about the user
RevenueWithdrawalState	withdrawal_state	State of the transaction if the transaction is outgoing

Constructor Summary

Constructors

Constructor	Description
TransactionPartner()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

type

public TransactionPartnerType type

Type of the transaction partner

transaction_type

public String transaction_type

Type of the transaction, currently one of TransactionType.INVOICE_PAYMENT for payments via invoices, TransactionType.PAID_MEDIA_PAYMENT for payments for paid media, TransactionType.GIFT_PURCHASE for gifts sent by the bot, TransactionType.PREMIUM_PURCHASE for Telegram Premium subscriptions gifted by the bot, TransactionType.BUSINESS_ACCOUNT_TRANSFER for direct transfers from managed business accounts

invoice_payload

public String invoice_payload

Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.

user

public User user

Information about the user

withdrawal_state

public RevenueWithdrawalState withdrawal_state

State of the transaction if the transaction is outgoing

paid_media

public List<PaidMedia> paid_media

Information about the paid media bought by the user; for “paid_media_payment” transactions only

request_count

public Integer request_count

The number of successful requests that exceeded regular limits and were therefore billed

subscription_period

public Integer subscription_period

The duration of the paid subscription. Can be available only for “invoice_payment” transactions.

gift

public Gift gift

The gift sent to the user by the bot; for “gift_purchase” transactions only or The gift sent to the chat by the bot

affiliate

public AffiliateInfo affiliate

Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.

sponsor_user

public User sponsor_user

Information about the bot that sponsored the affiliate program

commission_per_mille

public Integer commission_per_mille

The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users

chat

public Chat chat

Information about the chat

premium_subscription_duration

public Integer premium_subscription_duration

Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only

Constructor Details

TransactionPartner

public TransactionPartner()