SuccessfulPayment

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

This object contains basic information about a successful payment.

Parameters

currency

Three-letter ISO 4217 currency code

totalAmount

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

invoicePayload

Bot specified invoice payload

shippingOptionId

Optional. Identifier of the shipping option chosen by the user

orderInfo

Optional. Order info provided by the user

telegramPaymentChargeId

Telegram payment identifier

providerPaymentChargeId

Provider payment identifier

Constructors

SuccessfulPayment
Link copied to clipboard
common
fun SuccessfulPayment(currency: String, totalAmount: Int, invoicePayload: String, shippingOptionId: String? = null, orderInfo: OrderInfo? = null, telegramPaymentChargeId: String, providerPaymentChargeId: String)
Three-letter ISO 4217 currency code

Functions

component1
Link copied to clipboard
common
operator fun component1(): String
component2
Link copied to clipboard
common
operator fun component2(): Int
component3
Link copied to clipboard
common
operator fun component3(): String
component4
Link copied to clipboard
common
operator fun component4(): String?
component5
Link copied to clipboard
common
operator fun component5(): OrderInfo?
component6
Link copied to clipboard
common
operator fun component6(): String
component7
Link copied to clipboard
common
operator fun component7(): String
copy
Link copied to clipboard
common
fun copy(currency: String, totalAmount: Int, invoicePayload: String, shippingOptionId: String? = null, orderInfo: OrderInfo? = null, telegramPaymentChargeId: String, providerPaymentChargeId: String): SuccessfulPayment
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

currency
Link copied to clipboard
common
val currency: String
Three-letter ISO 4217 currency code
invoicePayload
Link copied to clipboard
common
val invoicePayload: String
Bot specified invoice payload
orderInfo
Link copied to clipboard
common
val orderInfo: OrderInfo? = null
Optional.
providerPaymentChargeId
Link copied to clipboard
common
val providerPaymentChargeId: String
Provider payment identifier
shippingOptionId
Link copied to clipboard
common
val shippingOptionId: String? = null
Optional.
telegramPaymentChargeId
Link copied to clipboard
common
val telegramPaymentChargeId: String
Telegram payment identifier
totalAmount
Link copied to clipboard
common
val totalAmount: Int
Total price in the smallest units of the currency (integer, not float/double).