SuccessfulPayment

interface

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.

Declaration

interface SuccessfulPayment

Properties

currencyproperty#

currency: string;

Three-letter ISO 4217 currency code, or "XTR" for payments in Telegram Stars

invoice_payloadproperty#

invoice_payload: string;

Bot-specified invoice payload

is_first_recurringproperty#

is_first_recurring?: boolean;

Optional. True, if the payment is the first payment for a subscription

is_recurringproperty#

is_recurring?: boolean;

Optional. True, if the payment is a recurring payment for a subscription

order_infoproperty#

order_info?: OrderInfo;

Optional. Order information provided by the user

provider_payment_charge_idproperty#

provider_payment_charge_id: string;

Provider payment identifier

shipping_option_idproperty#

shipping_option_id?: string;

Optional. Identifier of the shipping option chosen by the user

subscription_expiration_dateproperty#

subscription_expiration_date?: number;

Optional. Expiration date of the subscription, in Unix time; for recurring payments only

telegram_payment_charge_idproperty#

telegram_payment_charge_id: string;

Telegram payment identifier

total_amountproperty#

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).