v1

latestOpenAPI 3.0.02026-07-1374103805.5 KB

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

post/sendInvoice

Request body

chat_idinteger required

Unique identifier for the target private 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 for your internal processes.

provider_tokenstring required

Payments provider token, obtained via Botfather

start_parameterstring required

Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter

currencystring required

Three-letter ISO 4217 currency code, see more on currencies

provider_datastring

A 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

photo_widthinteger

Photo width

photo_heightinteger

Photo height

need_nameboolean

Pass True, if you require the user's full name to complete the order

need_phone_numberboolean

Pass True, if you require the user's phone number to complete the order

need_emailboolean

Pass True, if you require the user's email address to complete the order

need_shipping_addressboolean

Pass True, if you require the user's shipping address to complete the order

send_phone_number_to_providerboolean

Pass True, if user's phone number should be sent to provider

send_email_to_providerboolean

Pass True, if user's email address should be sent to provider

is_flexibleboolean

Pass True, if the final price depends on the shipping method

disable_notificationboolean

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

reply_to_message_idinteger

If the message is a reply, ID of the original message

allow_sending_without_replyboolean

Pass True, if the message should be sent even if the specified replied-to message is not found

Response

okboolean required