GramIO API Reference / @gramio/contexts/dist / RefundedPayment
Class: RefundedPayment
Defined in: contexts/index.d.ts:4429
This object contains basic information about a refunded payment.
Constructors
Constructor
new RefundedPayment(
payload):RefundedPayment
Defined in: contexts/index.d.ts:4431
Parameters
| Parameter | Type |
|---|---|
payload | TelegramRefundedPayment |
Returns
RefundedPayment
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramRefundedPayment | contexts/index.d.ts:4430 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:4432
Returns
string
currency
Get Signature
get currency():
TelegramCurrencies
Defined in: contexts/index.d.ts:4436
Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”
Returns
invoicePayload
Get Signature
get invoicePayload():
string
Defined in: contexts/index.d.ts:4444
Bot-specified invoice payload
Returns
string
providerPaymentChargeId
Get Signature
get providerPaymentChargeId():
string
Defined in: contexts/index.d.ts:4452
Optional. Provider payment identifier
Returns
string
telegramPaymentChargeId
Get Signature
get telegramPaymentChargeId():
string
Defined in: contexts/index.d.ts:4448
Telegram payment identifier
Returns
string
totalAmount
Get Signature
get totalAmount():
number
Defined in: contexts/index.d.ts:4440
Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_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