applyGiftCode
Apply a Telegram Premium giftcode »
assignAppStoreTransaction
Informs server about a purchase made through the App Store: for official applications only.
assignPlayMarketTransaction
Informs server about a purchase made through the Play Store: for official applications only.
botCancelStarsSubscription
Cancel a bot subscription
canPurchaseStore
Checks whether a purchase is possible. Must be called before in-store purchase, official apps only.
changeStarsSubscription
Activate or deactivate a Telegram Star subscription ».
checkCanSendGift
Check if the specified gift » can be sent.
checkGiftCode
Obtain information about a Telegram Premium giftcode »
clearSavedInfo
Clear saved payment information
connectStarRefBot
Join a bot's affiliate program, becoming an affiliate »
convertStarGift
Convert a received gift » into Telegram Stars: this will permanently destroy the gift, converting it into starGift.convert_stars Telegram Stars, added to the user's balance. Note that starGift.convert_stars will be less than the buying price (starGift stars) of the gift if it was originally bought using Telegram Stars bought a long time ago.
craftStarGift
Craft a new collectible gift » by combining 1 to 4 owned collectible gifts of the same base gift type. The passed gifts must all have the same starGiftUnique.gift_id, must be usable for crafting, and must not be blocked by a future can_craft_at timestamp. The first passed gift must not be located on the TON blockchain.
createStarGiftCollection
Create a star gift collection ».
deleteStarGiftCollection
Delete a star gift collection ».
editConnectedStarRefBot
Leave a bot's affiliate program »
exportInvoice
Generate an invoice deep link
fulfillStarsSubscription
Re-join a private channel associated to an active Telegram Star subscription ».
getBankCardData
Get info about a credit card
getConnectedStarRefBot
Fetch info about a specific bot affiliation »
getConnectedStarRefBots
Fetch all affiliations we have created for a certain peer
getCraftStarGifts
Obtain owned collectible gifts » of a specific type that can be used for crafting ».
getGiveawayInfo
Obtain information about a Telegram Premium giveaway ».
getPaymentForm
Get a payment form
getPaymentReceipt
Get payment receipt
getPremiumGiftCodeOptions
Obtain a list of Telegram Premium giveaway/gift code » options.
getResaleStarGifts
Get collectible gifts of a specific type currently on resale, see here » for more info. sort_by_price and sort_by_num are mutually exclusive, if neither are set results are sorted by the unixtime (descending) when their resell price was last changed. See here » for detailed documentation on this method.
getSavedInfo
Get saved payment information
getSavedStarGift
Fetch info about specific gifts owned by a peer we control. Note that unlike what the name suggests, the method can be used to fetch both "saved" and "unsaved" gifts (aka gifts both pinned and not pinned to the profile).
getSavedStarGifts
Fetch the full list of gifts owned by a peer. Note that unlike what the name suggests, the method can be used to fetch both "saved" and "unsaved" gifts (aka gifts both pinned and not pinned) to the profile, depending on the passed flags.
getStarGiftActiveAuctions
Fetches all currently active gift auctions where the user has placed a bid.
getStarGiftAuctionAcquiredGifts
Fetches all the gifts that the current user won in an auction.
getStarGiftAuctionState
Returns info about a collectible gift auction »; also subscribes the user to auction updates, see here » for more info on the full flow.
getStarGiftCollections
Fetches all star gift collections » of a peer.
getStarGiftUpgradeAttributes
Obtains the full list of just the collectible attributes that may appear for a gift type once it's upgraded to a collectible gift ». The result may also include starGiftAttributeModel constructors with the crafted flag set: these models are reserved for crafting » and should be filtered out from regular upgrade previews (and vice versa).
getStarGiftUpgradePreview
Obtain a preview of the possible attributes (chosen randomly) a gift » can receive after upgrading it to a collectible gift », see here » for more info.
getStarGiftWithdrawalUrl
Convert a collectible gift » to an NFT on the TON blockchain.
getStarGifts
Get a list of available gifts, see here » for more info.
getStarsGiftOptions
Obtain a list of Telegram Stars gift options » as starsGiftOption constructors.
getStarsGiveawayOptions
Fetch a list of star giveaway options ».
getStarsRevenueAdsAccountUrl
Returns a URL for a Telegram Ad platform account that can be used to set up advertisements for channel/bot in peer, paid using the Telegram Stars owned by the specified peer, see here » for more info.
getStarsRevenueStats
Get Telegram Star revenue statistics ».
getStarsRevenueWithdrawalUrl
Withdraw funds from a channel or bot's star balance ».
getStarsStatus
Get the current Telegram Stars balance of the current account (with peer=inputPeerSelf), or the stars balance of the bot or channel specified in peer.
getStarsSubscriptions
Obtain a list of active, expired or cancelled Telegram Star subscriptions ».
getStarsTopupOptions
Obtain a list of Telegram Stars topup options » as starsTopupOption constructors.
getStarsTransactionsByID
Obtain info about Telegram Star transactions » using specific transaction IDs.
getStarsTransactions
Fetch Telegram Stars transactions. The inbound and outbound flags are mutually exclusive: if none of the two are set, both incoming and outgoing transactions are fetched.
getSuggestedStarRefBots
Obtain a list of suggested mini apps with available affiliate programs order_by_revenue and order_by_date are mutually exclusive: if neither is set, results are sorted by profitability.
getUniqueStarGiftValueInfo
Get information about the value of a collectible gift ».
getUniqueStarGift
Obtain info about a collectible gift » using a slug obtained from a collectible gift link ».
launchPrepaidGiveaway
Launch a prepaid giveaway ».
refundStarsCharge
Refund a Telegram Stars transaction, see here » for more info.
reorderStarGiftCollections
Reorder the star gift collections » on an owned peer's profile.
resolveStarGiftOffer
Accept or decline a previously received collectible gift purchase offer », see here » for the full flow.
saveStarGift
Display or remove a received gift » from our profile.
sendPaymentForm
Send compiled payment form
sendStarGiftOffer
Send an offer to purchase a collectible gift », see here » for the full flow.
sendStarsForm
Make a payment using Telegram Stars, see here » for more info.
toggleChatStarGiftNotifications
Enables or disables the reception of notifications every time a gift » is received by the specified channel, can only be invoked by admins with post_messages admin rights.
toggleStarGiftsPinnedToTop
Pins a received gift on top of the profile of the user or owned channels by using payments.toggleStarGiftsPinnedToTop.
transferStarGift
Transfer a collectible gift to another user or channel: can only be used if transfer is free (i.e. messageActionStarGiftUnique.transfer_stars is not set); see here » for more info on the full flow (including the different flow to use in case the transfer isn't free).
updateStarGiftCollection
Add or remove gifts from a star gift collection », or rename the collection.
updateStarGiftPrice
A collectible gift we own » can be put up for sale on the gift marketplace » with this method, see here » for more info.
upgradeStarGift
Upgrade a gift to a collectible gift: can only be used if the upgrade was already paid by the gift sender; see here » for more info on the full flow (including the different flow to use in case the upgrade was not paid by the gift sender).
validateRequestedInfo
Submit requested order information for validation