telegram.PreCheckoutQuery

class telegram.PreCheckoutQuery(id, from_user, currency, total_amount, invoice_payload, shipping_option_id=None, order_info=None, bot=None, **_kwargs)

Bases: telegram.base.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.

Parameters

  • id (str) – Unique query identifier.

  • from_user (telegram.User) – User who sent the query.

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

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

  • bot (telegram.Bot, optional) – The Bot to use for instance methods.

  • **kwargs (dict) – Arbitrary keyword arguments.

id

Unique query identifier.

Type

str

from_user

User who sent the query.

Type

telegram.User

currency

Three-letter ISO 4217 currency code.

Type

str

total_amount

Total price in the smallest units of the currency.

Type

int

invoice_payload

Bot specified invoice payload.

Type

str

shipping_option_id

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

Type

str

order_info

Optional. Order info provided by the user.

Type

telegram.OrderInfo

bot

Optional. The Bot to use for instance methods.

Type

telegram.Bot

answer(ok, error_message=None, timeout=None, api_kwargs=None)

Shortcut for:

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

Parameters

  • ok (bool) –

  • error_message (str) –

  • timeout (Optional[Union[DefaultValue[DVType], float]]) –

  • api_kwargs (Dict[str, Any]) –

Return type

bool