Telegram Bot/eu.vendeli.tgbot.types.payment/PreCheckoutQuery

PreCheckoutQuery

@Serializable

data class PreCheckoutQuery(val id: String, val from: User, val currency: Currency, val totalAmount: Int, val invoicePayload: String, val shippingOptionId: String? = null, val orderInfo: OrderInfo? = null)

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

Api reference

Constructors

PreCheckoutQuery

constructor(id: String, from: User, currency: Currency, totalAmount: Int, invoicePayload: String, shippingOptionId: String? = null, orderInfo: OrderInfo? = null)

Properties

currency

val currency: Currency

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

from

val from: User

User who sent the query

val id: String

Unique query identifier

invoicePayload

val invoicePayload: String

Bot-specified invoice payload

orderInfo

val orderInfo: OrderInfo? = null

Optional. Order information provided by the user

shippingOptionId

val shippingOptionId: String? = null

Optional. Identifier of the shipping option chosen by the user

totalAmount

val totalAmount: 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).