telegram api method · layer 229 · #69da4557

payments.getStarsTransactions

usable by users and bots

Fetch Telegram Stars transactions.

definition

payments.getStarsTransactions#69da4557 flags:# inbound:flags.0?true outbound:flags.1?true ascending:flags.2?true ton:flags.4?true subscription_id:flags.3?string peer:InputPeer offset:string limit:int = payments.StarsStatus;

parameters

nametypedescription
flags#Flags, see TL conditional fields
inboundflags.0?trueIf set, fetches only incoming transactions.
outboundflags.1?trueIf set, fetches only outgoing transactions.
ascendingflags.2?trueReturn transactions in ascending order by date (instead of descending order by date).
tonflags.4?trueIf set, returns the channel/ad revenue transactions in nanotons, instead.
subscription_idflags.3?stringIf set, fetches only transactions for the specified Telegram Star subscription ».
peerInputPeerFetch the transaction history of the peer (inputPeerSelf or a bot we own).
offsetstringOffset for pagination, obtained from the returned next_offset, initially an empty string ».
limitintMaximum number of results to return, see pagination

returns

payments.StarsStatus

errors (5)

codeerrordescription
400BUSINESS_CONNECTION_NOT_ALLOWEDThis method was invoked over a business connection using invokeWithBusinessConnection, but either (1) we're a user, and users cannot invoke methods over a business connection; (2) we're a bot, but business mode was disabled in @botfather or (3); we're a bot, but this method cannot be invoked over a business connection.
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this.
400PEER_ID_INVALIDThe provided peer id is invalid.
400SUBSCRIPTION_ID_INVALIDThe specified subscription_id is invalid.
401AUTH_KEY_UNREGISTEREDThe specified authorization key is not registered in the system (for example, a PFS temporary key has expired).

history

present in layers 181–229 · constructor id changed 2×

idlayers
#673ac2f9181
#97938d5a182–185
#69da4557186–229