SuccessfulPayment

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.

fields

field	type	required	description
`currency`	string	required	Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
`total_amount`	number	required	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).
`invoice_payload`	string	required	Bot-specified invoice payload
`subscription_expiration_date`	number	optional	Optional. Expiration date of the subscription, in Unix time; for recurring payments only
`is_recurring`	boolean	optional	Optional. True, if the payment is a recurring payment for a subscription
`is_first_recurring`	boolean	optional	Optional. True, if the payment is the first payment for a subscription
`shipping_option_id`	string	optional	Optional. Identifier of the shipping option chosen by the user
`order_info`	OrderInfo	optional	Optional. Order information provided by the user
`telegram_payment_charge_id`	string	required	Telegram payment identifier
`provider_payment_charge_id`	string	required	Provider payment identifier

import

types.ts

import type { SuccessfulPayment } from "@yaebal/types";

used by

types

Message

official Bot API docs: https://core.telegram.org/bots/api/#successfulpayment