Available methods

transferBusinessAccountStars()

Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.

parameters

parametertyperequireddescription
business_connection_idstringrequiredUnique identifier of the business connection
star_countnumberrequiredNumber of Telegram Stars to transfer; 1-10000

returns

boolean

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

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

await bot.api.call<boolean>("transferBusinessAccountStars", {
  business_connection_id: "...",
  star_count: 1,
} satisfies TransferBusinessAccountStarsParams);