Skip to content

GramIO API Reference / gramio/dist / TelegramPreCheckoutQuery

Interface: TelegramPreCheckoutQuery

Defined in: @gramio/types/out/objects.d.ts:8124

This object contains information about an incoming pre-checkout query.

Documentation

Properties

PropertyTypeDescriptionDefined in
currencyTelegramCurrenciesThree-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars@gramio/types/out/objects.d.ts:8136
fromTelegramUserUser who sent the query@gramio/types/out/objects.d.ts:8132
idstringUnique query identifier@gramio/types/out/objects.d.ts:8128
invoice_payloadstringBot-specified invoice payload@gramio/types/out/objects.d.ts:8144
order_info?TelegramOrderInfoOptional. Order information provided by the user@gramio/types/out/objects.d.ts:8152
shipping_option_id?stringOptional. Identifier of the shipping option chosen by the user@gramio/types/out/objects.d.ts:8148
total_amountnumberTotal 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).@gramio/types/out/objects.d.ts:8140