Class InputInvoiceMessageContent

java.lang.Object

io.github.natanimn.telebof.types.input.InputInvoiceMessageContent

All Implemented Interfaces:

InputMessageContent, Serializable

public class InputInvoiceMessageContent
extends Object
implements InputMessageContent

Represents the content of an invoice message to be sent as the result of an inline query.

Since:

3 March 2025

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InputInvoiceMessageContent(String title, String description, String payload, String currency, LabeledPrice[] prices)	Required

Method Summary

Modifier and Type	Method	Description
InputInvoiceMessageContent	isFlexible(Boolean is_flexible)	Optional
InputInvoiceMessageContent	maxTipAmount(int max_tip_amount)
InputInvoiceMessageContent	needEmail(Boolean need_email)	Optional
InputInvoiceMessageContent	needName(Boolean need_name)	Optional
InputInvoiceMessageContent	needPhoneNumber(Boolean need_phone_number)	Optional
InputInvoiceMessageContent	needShippingAddress(Boolean need_shipping_address)	Optional
InputInvoiceMessageContent	photoHeight(int photo_height)	Optional
InputInvoiceMessageContent	photoSize(int photo_size)	Optional
InputInvoiceMessageContent	photoUrl(String photo_url)	Optional
InputInvoiceMessageContent	photoWidth(int photo_width)	Optional
InputInvoiceMessageContent	providerData(String provider_data)	Optional
InputInvoiceMessageContent	providerToken(String provider_token)	Optional
InputInvoiceMessageContent	sendEmailToProvider(Boolean send_email_to_provider)	Optional
InputInvoiceMessageContent	sendPhoneNumberToProvider(Boolean send_phone_number_to_provider)	Optional
InputInvoiceMessageContent	suggestedTipAmounts(Integer[] suggested_tip_amounts)	Optional

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InputInvoiceMessageContent

public InputInvoiceMessageContent(String title,
 String description,
 String payload,
 String currency,
 LabeledPrice[] prices)

Required

Parameters:

title - Product name, 1-32 characters

description - Product description, 1-255 characters

payload - Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.

currency - Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.

prices - Price breakdown. Must contain exactly one item for payments in Telegram Stars.

Method Details

providerToken

public InputInvoiceMessageContent providerToken(String provider_token)

Optional

Parameters:

provider_token -

Returns:

InputInvoiceMessageContent

maxTipAmount

public InputInvoiceMessageContent maxTipAmount(int max_tip_amount)

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:

InputInvoiceMessageContent

suggestedTipAmounts

public InputInvoiceMessageContent suggestedTipAmounts(Integer[] suggested_tip_amounts)

Optional

Parameters:

suggested_tip_amounts - array of suggested amounts of tip 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 maxTipAmount(int).

Returns:

InputInvoiceMessageContent

providerData

public InputInvoiceMessageContent providerData(String provider_data)

Optional

Parameters:

provider_data - data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.

Returns:

InputInvoiceMessageContent

photoUrl

public InputInvoiceMessageContent 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.

Returns:

InputInvoiceMessageContent

photoSize

public InputInvoiceMessageContent photoSize(int photo_size)

Optional

Parameters:

photo_size - Photo size in bytes

Returns:

InputInvoiceMessageContent

photoWidth

public InputInvoiceMessageContent photoWidth(int photo_width)

Optional

Parameters:

photo_width - Photo width

Returns:

InputInvoiceMessageContent

photoHeight

public InputInvoiceMessageContent photoHeight(int photo_height)

Optional

Parameters:

photo_height - Photo height

Returns:

InputInvoiceMessageContent

needName

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent

needPhoneNumber

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent

needEmail

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent

needShippingAddress

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent

sendPhoneNumberToProvider

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent

sendEmailToProvider

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent

isFlexible

public InputInvoiceMessageContent 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:

InputInvoiceMessageContent