Sign in
Telegram Bot API

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

post/createInvoiceLink

Request

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

Request body

business_connection_idstring

Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.

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.

subscription_periodinteger

The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.

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.

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.

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.

Response

Telegram API response

oktrue required
resultstring required

Changes

No recorded changes to this operation across all 3 revisions of this API.