Link Search Menu Expand Document

Constructor: inputStorePaymentStarsTopup

Back to constructors index

Used to top up the Telegram Stars balance of the current account.

Attributes:

NameTypeRequiredDescription
starslongYesAmount of stars to topup
currencystringYesThree-letter ISO 4217 currency code
amountlongYesTotal price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
spend_purpose_peerUsername, chat ID, Update, Message or InputPeerOptionalShould be populated with the peer where the topup process was initiated due to low funds (i.e. a bot for bot payments, a channel for paid media/reactions, etc); leave this flag unpopulated if the topup flow was not initated when attempting to spend more Stars than currently available on the account’s balance.

Type: InputStorePaymentPurpose

Example:

$inputStorePaymentStarsTopup = ['_' => 'inputStorePaymentStarsTopup', 'stars' => long, 'currency' => 'string', 'amount' => long, 'spend_purpose_peer' => InputPeer];