Skip to content

GramIO API Reference / gramio/dist / TelegramRefundedPayment

Interface: TelegramRefundedPayment

Defined in: @gramio/types/out/objects.d.ts:10603

This object contains basic information about a refunded payment.

Documentation

Properties

PropertyTypeDescriptionDefined in
currencyTelegramCurrenciesThree-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”.@gramio/types/out/objects.d.ts:10607
invoice_payloadstringBot-specified invoice payload@gramio/types/out/objects.d.ts:10615
provider_payment_charge_id?stringOptional. Provider payment identifier@gramio/types/out/objects.d.ts:10623
telegram_payment_charge_idstringTelegram payment identifier@gramio/types/out/objects.d.ts:10619
total_amountnumberTotal 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).@gramio/types/out/objects.d.ts:10611