Payments

TransactionPartnerUser

Describes a transaction with a user.

fields

fieldtyperequireddescription
typestringrequiredType of the transaction partner, always “user”
transaction_type"invoice_payment" | "paid_media_payment" | "gift_purchase" | "premium_purchase" | "business_account_transfer"requiredType of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts
userUserrequiredInformation about the user
affiliateAffiliateInfooptionalOptional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.
invoice_payloadstringoptionalOptional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.
subscription_periodnumberoptionalOptional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.
paid_mediaPaidMedia[]optionalOptional. Information about the paid media bought by the user; for “paid_media_payment” transactions only
paid_media_payloadstringoptionalOptional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.
giftGiftoptionalOptional. The gift sent to the user by the bot; for “gift_purchase” transactions only
premium_subscription_durationnumberoptionalOptional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only

import

types.ts
import type { TransactionPartnerUser } from "@yaebal/types";

used by

types