Тип данных TransactionPartnerUser

Объект описывает транзакцию бота с пользователем, включая тип операции, информацию о пользователе и дополнительные данные в зависимости от вида платежа.

Описание

Описывает транзакцию с пользователем.

Поле Тип Описание
type String Тип партнёра по транзакции, всегда "user"
transaction_type String Тип транзакции, в настоящее время один из "invoice_payment" для платежей через инвойсы, "paid_media_payment" для платежей за платный медиаконтент, "gift_purchase" для подарков, отправленных ботом, "premium_purchase" для подписок Telegram Premium, подаренных ботом, "business_account_transfer" для прямых переводов с управляемых бизнес-аккаунтов
user User Информация о пользователе
affiliate AffiliateInfo Необязательный. Информация о партнёре, получившем комиссию через эту транзакцию. Может быть доступна только для транзакций "invoice_payment" и "paid_media_payment".
invoice_payload String Необязательный. Полезная нагрузка инвойса, указанная ботом. Может быть доступна только для транзакций "invoice_payment".
subscription_period Integer Необязательный. Длительность платной подписки. Может быть доступна только для транзакций "invoice_payment".
paid_media Array of PaidMedia Необязательный. Информация о платном медиаконтенте, купленном пользователем; только для транзакций "paid_media_payment"
paid_media_payload String Необязательный. Полезная нагрузка платного медиаконтента, указанная ботом. Может быть доступна только для транзакций "paid_media_payment".
gift Gift Необязательный. Подарок, отправленный пользователю ботом; только для транзакций "gift_purchase"
premium_subscription_duration Integer Необязательный. Количество месяцев, на которые будет активна подаренная подписка Telegram Premium; только для транзакций "premium_purchase"

Примеры

json

{
  "type": "user",
  "transaction_type": "invoice_payment",
  "user": {
    "id": 123456789,
    "is_bot": false,
    "first_name": "John",
    "last_name": "Doe",
    "username": "johndoe",
    "language_code": "en"
  },
  "affiliate": {
    "affiliate_user": {
      "id": 987654321,
      "is_bot": false,
      "first_name": "Affiliate",
      "username": "affiliate_bot"
    },
    "commission_per_mille": 100
  },
  "invoice_payload": "order_12345",
  "subscription_period": 30
}

История изменений

  • API 7.9. Обновлен объект TransactionPartnerUser: Добавлено поле paid_media для транзакций с платным контентом
  • API 7.10. Обновлен объект TransactionPartnerUser: Добавлена возможность получать payload
  • API 8.0. Обновлен объект TransactionPartnerUser: Добавлены поля subscription_period и gift
  • API 8.1. Обновлен объект TransactionPartnerUser: Добавлено поле affiliate для идентификации партнера в транзакциях с комиссией

Дополнительно

  • User - Объект, представляющий пользователя или бота Telegram с основной информацией и настройками.
  • AffiliateInfo - Объект содержит информацию о партнёре, получившем комиссию от транзакции в Telegram Stars.
  • PaidMedia - Объект, представляющий платный медиаконтент в Telegram, который может быть превью, фото или видео.
  • Gift - Объект представляет виртуальный подарок в виде стикера, который можно отправить через бота, используя Telegram Stars.
Комментарии