telegram.PreCheckoutQuery¶
-
class
telegram.
PreCheckoutQuery
(id: str, from_user: telegram.user.User, currency: str, total_amount: int, invoice_payload: str, shipping_option_id: str = None, order_info: telegram.payment.orderinfo.OrderInfo = None, bot: 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.
-
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
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 passamount = 145
. See theexp
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.
-
answer
(*args, **kwargs) → bool¶ Shortcut for:
bot.answer_pre_checkout_query(update.pre_checkout_query.id, *args, **kwargs)
Parameters: - ok (
bool
) – SpecifyTrue
if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. UseFalse
if there are any problems. - error_message (
str
, optional) – Required if ok isFalse
. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user. - **kwargs (
dict
) – Arbitrary keyword arguments.
- ok (