Telegram Bot/eu.vendeli.tgbot.types.payment/SuccessfulPayment

SuccessfulPayment

@Serializable
data class SuccessfulPayment(val currency: Currency, val totalAmount: Int, val invoicePayload: String, val shippingOptionId: String? = null, val orderInfo: OrderInfo? = null, val subscriptionExpirationDate: Instant? = null, val isRecurring: Boolean? = null, val isFirstRecurring: Boolean? = null, val telegramPaymentChargeId: String, val providerPaymentChargeId: String)

This object contains basic information about a successful payment.

Api reference

Constructors

Link copied to clipboard
constructor(currency: Currency, totalAmount: Int, invoicePayload: String, shippingOptionId: String? = null, orderInfo: OrderInfo? = null, subscriptionExpirationDate: Instant? = null, isRecurring: Boolean? = null, isFirstRecurring: Boolean? = null, telegramPaymentChargeId: String, providerPaymentChargeId: String)

Properties

Link copied to clipboard
val currency: Currency

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

Link copied to clipboard
val invoicePayload: String

Bot-specified invoice payload

Link copied to clipboard
val isFirstRecurring: Boolean? = null

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

Link copied to clipboard
val isRecurring: Boolean? = null

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

Link copied to clipboard
val orderInfo: OrderInfo? = null

Optional. Order information provided by the user

Link copied to clipboard
val providerPaymentChargeId: String

Provider payment identifier

Link copied to clipboard
val shippingOptionId: String? = null

Optional. Identifier of the shipping option chosen by the user

Link copied to clipboard
@Serializable(with = InstantSerializer::class)
val subscriptionExpirationDate: Instant? = null

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

Link copied to clipboard
val telegramPaymentChargeId: String

Telegram payment identifier

Link copied to clipboard
val totalAmount: Int

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