simbot-component-telegram-type/love.forte.simbot.telegram.type.payment/SuccessfulPayment

SuccessfulPayment

data class SuccessfulPayment(val currency: String, val totalAmount: Int, val invoicePayload: String, val shippingOptionId: String? = null, val orderInfo: OrderInfo? = null, val telegramPaymentChargeId: String, val providerPaymentChargeId: String)(source)

SuccessfulPayment

This object contains basic information about a successful payment.

Author

ForteScarlet

Constructors

SuccessfulPayment

constructor(currency: String, totalAmount: Int, invoicePayload: String, shippingOptionId: String? = null, orderInfo: OrderInfo? = null, telegramPaymentChargeId: String, providerPaymentChargeId: String)

Properties

currency

val currency: String

Three-letter ISO 4217 currency code

invoicePayload

@SerialName(value = "invoice_payload")

val invoicePayload: String

Bot specified invoice payload

orderInfo

@SerialName(value = "order_info")

val orderInfo: OrderInfo? = null

Optional. Order information provided by the user

providerPaymentChargeId

@SerialName(value = "provider_payment_charge_id")

val providerPaymentChargeId: String

Provider payment identifier

shippingOptionId

@SerialName(value = "shipping_option_id")

val shippingOptionId: String? = null

Optional. Identifier of the shipping option chosen by the user

telegramPaymentChargeId

@SerialName(value = "telegram_payment_charge_id")

val telegramPaymentChargeId: String

Telegram payment identifier

totalAmount

@SerialName(value = "total_amount")

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