GramIO API Reference / @gramio/contexts/dist / SuccessfulPayment
Class: SuccessfulPayment
Defined in: contexts/index.d.ts:2901
This object contains basic information about a successful payment.
Constructors
Constructor
new SuccessfulPayment(
payload):SuccessfulPayment
Defined in: contexts/index.d.ts:2903
Parameters
| Parameter | Type |
|---|---|
payload | TelegramSuccessfulPayment |
Returns
SuccessfulPayment
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramSuccessfulPayment | contexts/index.d.ts:2902 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:2905
Returns
string
currency
Get Signature
get currency():
TelegramCurrencies
Defined in: contexts/index.d.ts:2907
Three-letter ISO 4217 currency code
Returns
invoicePayload
Get Signature
get invoicePayload():
string
Defined in: contexts/index.d.ts:2918
Bot specified invoice payload
Returns
string
orderInfo
Get Signature
get orderInfo():
OrderInfo
Defined in: contexts/index.d.ts:2922
Order info provided by the user
Returns
providerPaymentChargeId
Get Signature
get providerPaymentChargeId():
string
Defined in: contexts/index.d.ts:2926
Provider payment identifier
Returns
string
shippingOptionId
Get Signature
get shippingOptionId():
string
Defined in: contexts/index.d.ts:2920
Identifier of the shipping option chosen by the user
Returns
string
telegramPaymentChargeId
Get Signature
get telegramPaymentChargeId():
string
Defined in: contexts/index.d.ts:2924
Telegram payment identifier
Returns
string
totalAmount
Get Signature
get totalAmount():
number
Defined in: contexts/index.d.ts:2916
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