GramIO API Reference / @gramio/contexts/dist / PreCheckoutQuery
Class: PreCheckoutQuery
Defined in: contexts/index.d.ts:4382
This object contains information about an incoming pre-checkout query.
Extended by
Constructors
Constructor
new PreCheckoutQuery(
payload):PreCheckoutQuery
Defined in: contexts/index.d.ts:4384
Parameters
| Parameter | Type |
|---|---|
payload | TelegramPreCheckoutQuery |
Returns
PreCheckoutQuery
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramPreCheckoutQuery | contexts/index.d.ts:4383 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:4386
Returns
string
currency
Get Signature
get currency():
TelegramCurrencies
Defined in: contexts/index.d.ts:4394
Three-letter ISO 4217 currency code
Returns
from
Get Signature
get from():
User
Defined in: contexts/index.d.ts:4390
User who sent the query
Returns
id
Get Signature
get id():
string
Defined in: contexts/index.d.ts:4388
Unique query identifier
Returns
string
invoicePayload
Get Signature
get invoicePayload():
string
Defined in: contexts/index.d.ts:4405
Bot specified invoice payload
Returns
string
orderInfo
Get Signature
get orderInfo():
OrderInfo
Defined in: contexts/index.d.ts:4409
Order info provided by the user
Returns
senderId
Get Signature
get senderId():
number
Defined in: contexts/index.d.ts:4392
Sender ID
Returns
number
shippingOptionId
Get Signature
get shippingOptionId():
string
Defined in: contexts/index.d.ts:4407
Identifier of the shipping option chosen by the user
Returns
string
totalAmount
Get Signature
get totalAmount():
number
Defined in: contexts/index.d.ts:4403
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).
Returns
number