docs/dev.inmo.tgbotapi.types.payments

Package-level declarations

Types

@Serializable

data class AffiliateInfo(val commissionPerMille: Int, val amount: Long, val nanostarAmount: Long, val affiliateUser: User? = null, val affiliateChat: PreviewChat? = null) : Amounted

@Serializable

Information about changes to a user payment subscription toward the current bot

@Serializable

data class Invoice(val title: String, val description: String, val startParameter: StartParameter, val currency: Currency, val amount: Long) : Amounted, Currencied, ReplyInfo.External.ContentVariant

@Serializable

data class LabeledPrice(val label: String, val amount: Long) : Amounted

@Serializable

data class OrderInfo(val name: String? = null, val phoneNumber: String? = null, val email: String? = null, val shippingAddress: ShippingAddress? = null)

All the field of this class are nullable due to specific of OrderInfo from official bots api

@Serializable

data class PreCheckoutQuery(val id: PreCheckoutQueryId, val from: User, val currency: Currency, val amount: Long, val invoicePayload: InvoicePayload, val shippingOptionId: ShippingOptionId? = null, val orderInfo: OrderInfo? = null) : Currencied, Amounted, FromUser

@Serializable

data class RecurringInfo(val subscriptionExpirationDate: TelegramDate, val firstSubscriptionPeriod: Boolean)

@Serializable

data class RefundedPayment(val currency: Currency, val amount: Long, val invoicePayload: String, val telegramPaymentChargeId: TelegramPaymentChargeId, val providerPaymentChargeId: String? = null) : Amounted, Currencied

@Serializable

data class ShippingAddress(val countryCode: String, val city: String, val firstStreetLine: String, val secondStreetLine: String, val state: String = "", val postCode: String = "")

@Serializable

@Serializable

data class ShippingQuery(val id: ShippingQueryId, val from: User, val invoicePayload: InvoicePayload, val shippingAddress: ShippingAddress) : FromUser

@Serializable

data class SuccessfulPayment(val currency: Currency, val amount: Long, val invoicePayload: String, val subscriptionExpirationDate: TelegramDate? = null, val isSubscriptionPayment: Boolean? = null, val isFirstPeriodPayment: Boolean? = null, val telegramPaymentChargeId: TelegramPaymentChargeId, val providerPaymentChargeId: String, val shippingOptionId: String? = null, val orderInfo: OrderInfo? = null) : Amounted, Currencied

@Serializable