PreCheckoutQuery¶

class telegram.PreCheckoutQuery(id, from_user, currency, total_amount, invoice_payload, shipping_option_id=None, order_info=None, *, api_kwargs=None)[source]¶

Bases: telegram.TelegramObject

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

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their id is equal.

Note

In Python from is a reserved word. Use from_user instead.

Available In

telegram.Update.pre_checkout_query

Parameters:

id (str) – Unique query identifier.
from_user (telegram.User) – User who sent the query.
currency (str) – Three-letter ISO 4217 currency code, or XTR for payments in Telegram Stars.
total_amount (int) – 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).
invoice_payload (str) – Bot-specified invoice payload.
shipping_option_id (str, optional) – Identifier of the shipping option chosen by the user.
order_info (telegram.OrderInfo, optional) – Order info provided by the user.

id[source]¶

Unique query identifier.

Type:: str

from_user[source]¶

User who sent the query.

Type:: telegram.User

currency[source]¶

Three-letter ISO 4217 currency code, or XTR for payments in Telegram Stars.

Type:: str

total_amount[source]¶

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).

Type:: int

invoice_payload[source]¶

Bot-specified invoice payload.

Type:: str

shipping_option_id[source]¶

Optional. Identifier of the shipping option chosen by the user.

Type:: str

order_info[source]¶

Optional. Order info provided by the user.

Type:: telegram.OrderInfo

async answer(ok, error_message=None, *, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶

Shortcut for:

await bot.answer_pre_checkout_query(update.pre_checkout_query.id, *args, **kwargs)

For the documentation of the arguments, please see telegram.Bot.answer_pre_checkout_query().

classmethod de_json(data, bot=None)[source]¶: See telegram.TelegramObject.de_json().