invoice

inline fun invoice(title: String, description: String, payload: String, providerToken: String? = null, currency: Currency, prices: List<LabeledPrice>): SendInvoiceAction

Use this method to send invoices. On success, the sent Message is returned.

Api reference

Parameters

chatId

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

messageThreadId

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

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.

providerToken

Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.

currency

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

prices

Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.

maxTipAmount

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.

suggestedTipAmounts

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.

startParameter

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

providerData

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.

photoUrl

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.

photoSize

Photo size in bytes

photoWidth

Photo width

photoHeight

Photo height

needName

Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.

needPhoneNumber

Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.

needEmail

Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.

needShippingAddress

Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.

sendPhoneNumberToProvider

Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.

sendEmailToProvider

Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.

isFlexible

Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

disableNotification

Sends the message silently. Users will receive a notification with no sound.

protectContent

Protects the contents of the sent message from forwarding and saving

allowPaidBroadcast

Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance

messageEffectId

Unique identifier of the message effect to be added to the message; for private chats only

replyParameters

Description of the message to reply to

replyMarkup

A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.


inline fun invoice(title: String, description: String, providerToken: String? = null, currency: Currency, vararg prices: LabeledPrice, payload: () -> String): SendInvoiceAction