PreCheckoutQuery

class ftmgram.types.PreCheckoutQuery(*, client: Client = None, id: str, from_user: User, currency: str, total_amount: int, invoice_payload: str, shipping_option_id: str | None = None, order_info: OrderInfo | None = None)

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

Parameters:

  • id (str) – Unique identifier for this query.

  • from_user (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-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

  • shipping_option_id (str, optional) – Identifier of the shipping option chosen by the user.

  • order_info (OrderInfo, optional) – Payment information provided by the user.

answer(ok: bool = None, error_message: str = None)

Bound method answer of PreCheckoutQuery.

Use this method as a shortcut for:

await client.answer_pre_checkout_query(
    pre_checkout_query.id,
    ok=True
)

Example

await pre_checkout_query.answer(ok=True)
Parameters:

  • ok (bool optional) – Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

  • error_message (str optional) – Required if ok is False. 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.

Returns:

bool – True, on success.