Payments

answerPreCheckoutQuery()

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

parameters

parametertyperequireddescription
pre_checkout_query_idstringrequiredUnique identifier for the query to be answered
okbooleanrequiredSpecify 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_messagestringoptionalRequired 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

boolean

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { AnswerPreCheckoutQueryParams } from "@yaebal/types";

await bot.api.call<boolean>("answerPreCheckoutQuery", {
  pre_checkout_query_id: "...",
  ok: true,
} satisfies AnswerPreCheckoutQueryParams);

context shortcut

also available as ctx.answer() on 1 context type — see @yaebal/contexts.

context shortcut
/** Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an [Update](https://core.telegram.org/bots/api/#update) with the field *pre\_checkout\_query*. Use this method to respond to such pre-checkout queries. On success, *True* is returned. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. */
ctx.answer(params: Omit<AnswerPreCheckoutQueryParams, "pre_checkout_query_id">)