sendInvoice
Use this method to send invoices
Field | Description |
---|---|
chat_id
*
| Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
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, 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. |
message_thread_id | Unique identifier for the target message thread (topic) of the forum; for forum supergroups only |
provider_token | Payment provider token, obtained via @BotFather Pass an empty string for payments in Telegram Stars. |
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. |
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. |
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 |
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. |
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. |
photo_size | Photo size in bytes |
photo_width | Photo width |
photo_height | Photo height |
need_name | Pass True if you require the user's full name to complete the order Ignored for payments in Telegram Stars. |
need_phone_number | Pass True if you require the user's phone number to complete the order Ignored for payments in Telegram Stars. |
need_email | Pass True if you require the user's email address to complete the order Ignored for payments in Telegram Stars. |
need_shipping_address | Pass True if you require the user's shipping address to complete the order Ignored for payments in Telegram Stars. |
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. |
send_email_to_provider | Pass True if the user's email address should be sent to the provider Ignored for payments in Telegram Stars. |
is_flexible | Pass True if the final price depends on the shipping method Ignored for payments in Telegram Stars. |
disable_notification | Sends the message silently Users will receive a notification with no sound. |
protect_content | Protects the contents of the sent message from forwarding and saving |
allow_paid_broadcast | 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 |
message_effect_id | Unique identifier of the message effect to be added to the message; for private chats only |
reply_parameters | Description of the message to reply to |
reply_markup | 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. |