GramIO API Reference / gramio/dist / TelegramSuccessfulPayment
Interface: TelegramSuccessfulPayment
Defined in: @gramio/types/out/objects.d.ts:7852
This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
currency | TelegramCurrencies | Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars | @gramio/types/out/objects.d.ts:7856 |
invoice_payload | string | Bot-specified invoice payload | @gramio/types/out/objects.d.ts:7864 |
is_first_recurring? | true | Optional. True, if the payment is the first payment for a subscription | @gramio/types/out/objects.d.ts:7876 |
is_recurring? | true | Optional. True, if the payment is a recurring payment for a subscription | @gramio/types/out/objects.d.ts:7872 |
order_info? | TelegramOrderInfo | Optional. Order information provided by the user | @gramio/types/out/objects.d.ts:7884 |
provider_payment_charge_id | string | Provider payment identifier | @gramio/types/out/objects.d.ts:7892 |
shipping_option_id? | string | Optional. Identifier of the shipping option chosen by the user | @gramio/types/out/objects.d.ts:7880 |
subscription_expiration_date? | number | Optional. Expiration date of the subscription, in Unix time; for recurring payments only | @gramio/types/out/objects.d.ts:7868 |
telegram_payment_charge_id | string | Telegram payment identifier | @gramio/types/out/objects.d.ts:7888 |
total_amount | number | 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). | @gramio/types/out/objects.d.ts:7860 |