InputStorePaymentStarsTopup

class pyrogram.raw.types.InputStorePaymentStarsTopup

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

Constructor of InputStorePaymentPurpose.

Details:

  • Layer: 223

  • ID: F9A2A6CB

Parameters:

  • stars (int 64-bit) – Amount of stars to topup

  • currency (str) – Three-letter ISO 4217 currency code

  • amount (int 64-bit) – Total 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_peer (InputPeer, optional) – Should 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.

TL Schema

inputStorePaymentStarsTopup#f9a2a6cb
flags:#
stars:long
currency:string
amount:long
spend_purpose_peer:flags.0?InputPeer

= InputStorePaymentPurpose

Parameter Tree

InputStorePaymentStarsTopup
├── stars → long
├── currency → string
├── amount → long
└── spend_purpose_peer → InputPeer (optional)
├── InputPeerEmpty
├── InputPeerSelf
├── InputPeerChat
│ └── chat_id → long
├── InputPeerUser
│ ├── user_id → long
│ └── access_hash → long
├── InputPeerChannel
│ ├── channel_id → long
│ └── access_hash → long
├── InputPeerUserFromMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── user_id → long
└── InputPeerChannelFromMessage
├── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── InputPeerUserFromMessage
│ └── InputPeerChannelFromMessage
├── msg_id → int
└── channel_id → long

Example

InputStorePaymentStarsTopup(
    stars=0,
    currency="text",
    amount=0,
)