Package io.github.natanimn.telebof.types.payments

Class SuccessfulPayment

java.lang.Object
io.github.natanimn.telebof.types.payments.SuccessfulPayment
public class SuccessfulPayment extends Object
This class 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.
Since:
3 March 2025
Author:
Natanim

  • Field Details

    • currency

      private String currency
      Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars

    • totalAmount

      @SerializedName("total_amount") private Integer totalAmount
      Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_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)

    • subscriptionExpirationDate

      @SerializedName("subscription_expiration_date") private Integer subscriptionExpirationDate
      Expiration date of the subscription, in Unix time; for recurring payments only

    • invoicePayload

      @SerializedName("invoice_payload") private String invoicePayload
      Bot-specified invoice payload

    • shippingOptionId

      @SerializedName("shipping_option_id") private String shippingOptionId
      Identifier of the shipping option chosen by the user

    • orderInfo

      @SerializedName("order_info") private OrderInfo orderInfo
      Order information provided by the user

    • telegramPaymentChargeId

      @SerializedName("telegram_payment_charge_id") private String telegramPaymentChargeId
      Telegram payment identifier

    • providerPaymentChargeId

      @SerializedName("provider_payment_charge_id") private String providerPaymentChargeId
      Provider payment identifier

    • isRecurring

      @SerializedName("is_recurring") private Boolean isRecurring
      True, if the payment is a recurring payment for a subscription

    • isFirstRecurring

      @SerializedName("is_first_recurring") private Boolean isFirstRecurring
      True, if the payment is the first payment for a subscription

  • Constructor Details

    • SuccessfulPayment

      public SuccessfulPayment()

  • Method Details

    • getCurrency

      public String getCurrency()

    • getTotalAmount

      public Integer getTotalAmount()

    • getSubscriptionExpirationDate

      public Integer getSubscriptionExpirationDate()

    • getInvoicePayload

      public String getInvoicePayload()

    • getShippingOptionId

      public String getShippingOptionId()

    • getOrderInfo

      public OrderInfo getOrderInfo()

    • getTelegramPaymentChargeId

      public String getTelegramPaymentChargeId()

    • getProviderPaymentChargeId

      public String getProviderPaymentChargeId()

    • getIsRecurring

      public Boolean getIsRecurring()

    • getIsFirstRecurring

      public Boolean getIsFirstRecurring()