Class SendInvoice

java.lang.Object
io.github.natanimn.telebof.requests.AbstractBaseRequest<SendInvoice, Message>
io.github.natanimn.telebof.requests.send.SendBuilder<SendInvoice, Message>
io.github.natanimn.telebof.requests.send.SendInvoice
public class SendInvoice extends SendBuilder<SendInvoice, Message>
SendInvoice class. Returns the sent Message on success.
Since:
3 March 2025
See Also:

  • Constructor Details

    • SendInvoice

      public SendInvoice(Object chat_id, String title, String description, String payload, String currency, LabeledPrice[] prices, Api api)
      Required
      Parameters:
      chat_id - chat id
      title - title
      description - description
      payload - payload
      currency - currency
      prices - prices
      api - api

  • Method Details

    • providerToken

      public SendInvoice providerToken(String provider_token)
      Optional
      Parameters:
      provider_token - Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
      Returns:
      SendInvoice

    • maxTipAmount

      public SendInvoice maxTipAmount(int max_tip_amount)
      Optional
      Parameters:
      max_tip_amount - The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_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). Defaults to 0. Not supported for payments in Telegram Stars.
      Returns:
      SendInvoice

    • suggestedTipAmounts

      public SendInvoice suggestedTipAmounts(int[] suggested_tip_amounts)
      Optional
      Parameters:
      suggested_tip_amounts - A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
      Returns:
      SendInvoice

    • startParameter

      public SendInvoice startParameter(String start_parameter)
      Optional
      Parameters:
      start_parameter - Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter
      Returns:
      SendInvoice

    • providerData

      public SendInvoice providerData(String provider_data)
      Optional
      Parameters:
      provider_data - JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
      Returns:
      SendInvoice

    • photoUrl

      public SendInvoice photoUrl(String photo_url)
      Optional
      Parameters:
      photo_url - URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
      Returns:
      SendInvoice

    • photoSize

      public SendInvoice photoSize(int photo_size)
      Optional
      Parameters:
      photo_size - Photo size in bytes
      Returns:
      SendInvoice

    • photoWidth

      public SendInvoice photoWidth(int photo_width)
      Optional
      Parameters:
      photo_width - Photo width
      Returns:
      SendInvoice

    • photoHeight

      public SendInvoice photoHeight(int photo_height)
      Optional
      Parameters:
      photo_height - Photo height
      Returns:
      SendInvoice

    • needName

      public SendInvoice needName(boolean need_name)
      Optional
      Parameters:
      need_name - Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice

    • needPhoneNumber

      public SendInvoice needPhoneNumber(boolean need_phone_number)
      Optional
      Parameters:
      need_phone_number - Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice

    • needEmail

      public SendInvoice needEmail(boolean need_email)
      Optional
      Parameters:
      need_email - Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice

    • needShippingAddress

      public SendInvoice needShippingAddress(boolean need_shipping_address)
      Optional
      Parameters:
      need_shipping_address - Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice

    • sendPhoneNumberToProvider

      public SendInvoice sendPhoneNumberToProvider(boolean send_phone_number_to_provider)
      Optional
      Parameters:
      send_phone_number_to_provider - Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice

    • sendEmailToProvider

      public SendInvoice sendEmailToProvider(boolean send_email_to_provider)
      Optional
      Parameters:
      send_email_to_provider - Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice

    • isFlexible

      public SendInvoice isFlexible(boolean is_flexible)
      Optional
      Parameters:
      is_flexible - Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
      Returns:
      SendInvoice