Raw.StarsTransaction

Represents a telegram stars transaction.

starsTransaction#64dfc926 flags:# refund:flags.3?true pending:flags.4?true failed:flags.6?true gift:flags.10?true reaction:flags.11?true stargift_upgrade:flags.18?true id:string stars:StarsAmount date:int peer:StarsTransactionPeer title:flags.0?string description:flags.1?string photo:flags.2?WebDocument transaction_date:flags.5?int transaction_url:flags.5?string bot_payload:flags.7?bytes msg_id:flags.8?int extended_media:flags.9?Vector<MessageMedia> subscription_period:flags.12?int giveaway_post_id:flags.13?int stargift:flags.14?StarGift floodskip_number:flags.15?int starref_commission_permille:flags.16?int starref_peer:flags.17?Peer starref_amount:flags.17?StarsAmount = StarsTransaction;

export namespace Raw {
  export class StarsTransaction {
    constructor(params: {
      refund?: boolean;
      pending?: boolean;
      failed?: boolean;
      gift?: boolean;
      reaction?: boolean;
      stargiftUpgrade?: boolean;
      id: string;
      stars: Raw.TypeStarsAmount;
      date: number;
      peer: Raw.TypeStarsTransactionPeer;
      title?: string;
      description?: string;
      photo?: Raw.TypeWebDocument;
      transactionDate?: number;
      transactionUrl?: string;
      botPayload?: Buffer;
      msgId?: number;
      extendedMedia?: Array<Raw.TypeMessageMedia>;
      subscriptionPeriod?: number;
      giveawayPostId?: number;
      stargift?: Raw.TypeStarGift;
      floodskipNumber?: number;
      starrefCommissionPermille?: number;
      starrefPeer?: Raw.TypePeer;
      starrefAmount?: Raw.TypeStarsAmount;
    }) {}
  }
}

Layer: 198
Constructor ID: 0x64dfc926

Property

• refund : boolean or undefined

  Whether this transaction is a refund.

• pending : boolean or undefined

  The transaction is currently pending.

• failed : boolean or undefined

  This transaction has failed.

• gift : boolean or undefined

  This transaction was a gift from the user in peer.peer.

• reaction : boolean or undefined

  This transaction is a paid reaction.

• stargiftUpgrade : boolean or undefined
• id : string

  Transaction id.

• stars : Raw.TypeStarsAmount

  Amount of stars (negative for outgoing transactions).

• date : number

  Date of the transaction (unixtime).

• peer : Raw.TypeStarsTransactionPeer

  Source of the incoming transaction, or its recipient for outgoing transactions.

• title : string or undefined

  For transactions with bots, title of the bought product.

• description : string or undefined

  For transactions with bots, description of the bought product.

• photo : Raw.TypeWebDocument or undefined

  For transactions with bots, photo of the bought product.

• transactionDate : number or undefined

  If neither pending nor failed are set, the transaction was completed successfully, and this field will contain the point in time (unix timestamp) when the withdrawal was completed successfully.

• transactionUrl : string or undefined

  If neither pending nor failed are set, the transaction was completed successfully, and this field will contain a url where the withdrawal transaction can be viewed.

• botPayload : Buffer or undefined

  Bot specified invoice payload (i.e. the payload passed to inputmediainvoice when creating the invoice).

• msgId : number or undefined

  For paid media transactions, message id of the paid media posted to peer.peer (can point to a deleted message; either way, extendedMedia will always contain the bought media).

• extendedMedia : Array of Raw.TypeMessageMedia or undefined

  The purchased paid media.

• subscriptionPeriod : number or undefined

  The number of seconds between consecutive telegram star debiting for telegram star subscriptions.

• giveawayPostId : number or undefined

  Id of the message containing the messagemediagiveaway, for incoming star giveaway prizes.

• stargift : Raw.TypeStarGift or undefined

  This transaction indicates a purchase or a sale (conversion back to stars) of a gift.

• floodskipNumber : number or undefined

  This transaction is payment for paid bot broadcasts. paid broadcasts are only allowed if the allowPaidFloodskip parameter of messages.sendmessage and other message sending methods is set while trying to broadcast more than 30 messages per second to bot users. the integer value returned by this flag indicates the number of billed api calls.

• starrefCommissionPermille : number or undefined

  This transaction is the receival (or refund) of an affiliate commission (i.e. this is the transaction received by the peer that created the referral link, flag 17 is for transactions made by users that imported the referral link).

• starrefPeer : Raw.TypePeer or undefined

  For transactions made by referred users, the peer that received the affiliate commission.

• starrefAmount : Raw.TypeStarsAmount or undefined

  For transactions made by referred users, the amount of telegram stars received by the affiliate, can be negative for refunds.