Sign in
Telegram Bot API

Changed on

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

post/sendInvoice

Request

  • Base URL: https://api.telegram.org/bot<bot_token>
  • URL: https://api.telegram.org/bot<bot_token>/sendInvoice
  • Auth: none declared

Request body

message_thread_idinteger

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

direct_messages_topic_idinteger

Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

titlestring required

Product name, 1-32 characters

descriptionstring required

Product description, 1-255 characters

payloadstring required

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

provider_tokenstring

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

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BND' | 'BOB' | 'BRL' | 'BYN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'GBP' | 'GEL' | 'GHS' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KRW' | 'KZT' | 'LBP' | 'LKR' | 'MAD' | 'MDL' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'SYP' | 'THB' | 'TJS' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'XTR' | 'YER' | 'ZAR' required

Telegram payments supported currencies. Source: currencies.json. See also supported currencies.

max_tip_amountinteger

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_amountsinteger[]

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_parameterstring

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_datastring

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_urlstring

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_sizeinteger

Photo size in bytes

photo_widthinteger

Photo width

photo_heightinteger

Photo height

need_nameboolean

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

need_phone_numberboolean

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

need_emailboolean

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

need_shipping_addressboolean

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

send_phone_number_to_providerboolean

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

send_email_to_providerboolean

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

is_flexibleboolean

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

disable_notificationboolean

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

protect_contentboolean

Protects the contents of the sent message from forwarding and saving

allow_paid_broadcastboolean

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_idstring

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

Response

Telegram API response

oktrue required

Changes

  • e4c250383b33Revision changes
    • info

      added the new optional request property //////////// (media type: application/json)

    • info

      added the new optional request property //////////// (media type: application/x-www-form-urlencoded)

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property ///////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ///////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property ///////////////////// to the response with the status

    • info

      added the optional property /////////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status