Bot Payments API
- -Telegram Bot Payments are a free and open platform that allows sellers to accept payments for goods and services from Telegram users. Telegram doesn't collect payment information and takes no commission.
---Note: This article is intended for bot developers and store owners. If you're looking for a general overview of Telegram Payments, check out the Telegram blog.
-
If you are new to Telegram bots and would like to learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.
-Introducing Payments 2.0
-Payments 2.0 were added in April 2021 with Bot API v.5.2. New features:
--
-
- Send invoices to any chat, including to groups and channels. -
- Create invoices that can be forwarded and used by multiple buyers to order things. -
- Use inline mode to help users show your goods and services to their friends and communities. -
- Allow tips from users with preset and custom amounts. -
- Accept payments from users on mobile or desktop apps. -
- Try @ShopBot to create a test invoice – or start a message with
@ShopBot ...in any chat for an inline invoice.
- - Check out Demo Shop for an example of a Telegram Channel used as virtual storefront. -
--Users need to update to Telegram 7.7 or higher to use Payments 2.0 (for Telegram Desktop, 2.7.2 or higher). Older mobile apps released after May 2017 support basic payments in chats with bots.
-
How does this work?
-You create a bot that offers goods and services to Telegram users. Merchant bots can send specially formatted invoice messages to users, groups or channels. If your bot supports inline mode, users can also send invoices to other chats via the bot, including to one-on-one chats with other users.
-Invoice messages feature a photo and description of the product along with a prominent Pay button. Tapping this button opens a special payment interface in the Telegram app. In this interface, users can choose a tip amount (if allowed by the merchant) and enter additional details like shipping info, phone number, or email address.
-The bot can offer several shipping options for physical goods based on the delivery address. When ready, users enter their credit card info or choose a saved card — and pay for the product. Telegram also supports Apple Pay and Google Pay. Once the transaction is done, the merchant bot can send a receipt message with payment details, shipping and delivery information.
---Detailed information and step-by-step instructions are available below.
-
Supported Payment Providers
-Telegram does not process payments from users and instead relies on different payment providers around the world. It is the payment providers that handle and store all sensitive information, like credit card details. Neither Telegram nor the bot developers have access to it.
-For the moment we support payments from more than 200 countries via the following payment providers:
--
-
- Stripe -
- Smart Glocal -
- Tranzzo -
- YooMoney -
- Sberbank -
- PSB -
- Bank 131 -
- Payme -
- CLICK -
- LiqPay -
- LeoGaming -
- Cascad -
- Portmone -
- Paymega -
- ECOMMPAY -
- PayMaster -
- Global Pay UZ -
We continue expanding this list, follow @BotNews for updates.
---If you work for a company that provides services similar to standalone accounts in Stripe Connect, please let us know via @BotSupport (include the hashtag
-#paymentsproviderin your message).
-
The Payments API
-This section explores payments via Telegram's Bot API in more detail.
-Connecting Payments
-To start accepting payments, you need a Telegram bot. Use BotFather to create a bot if you don't have one already.
-Now you have a merchant bot that can offer goods or services to Telegram users. Let's call it @merchantbot in this document. The first stop is to choose and connect a payment provider, you can find the list of supported providers above.
Getting a Token
--
-
- Use the
/mybotscommand in the chat with BotFather and choose the@merchantbotthat will be offering goods or services.
- - Go to Bot Settings > Payments. -
- Choose a provider, and you will be redirected to the relevant bot. -
- Enter the required details so that the payments provider is connected successfully, go back to the chat with Botfather. -
- The message will now show available providers. Each will have a name, a token, and the date the provider was connected. -
- You will use the token when working with the Bot API. -
Implementing Payments
-You will find the necessary methods for building your payment implementation in the Payments Section of the Bot API Manual.
-Testing Payments: the 'Stripe TEST MODE' Provider
-While you're still developing and testing payments for your bot, use the “Stripe TEST MODE” provider. When in this mode, you can make payments without actually billing any accounts. Real cards can't be used in test mode, but you can use test cards like 4242 4242 4242 4242 (full list here). You can switch between test mode and live mode as many times as you want, but please see the live checklist before you go live.
Step-by-Step Process
---See Bot API: Payments for the complete list of available methods and objects.
-
1. Create Invoice
-The user contacts @merchantbot and requests to purchase something. The bot forms an invoice message with a description of the goods or service, amount to be paid, and requested shipping info. There are two ways of creating an invoice:
A. Bot Invoice
-Use the sendInvoice method to generate an invoice and send it to a chat. The provider_token parameter is where you put the token value that you've obtained earlier via Botfather. It is possible for one merchant bot to use several different tokens for different users or different goods and services.
-As of Payments 2.0, invoice messages with a pay button can be sent to chats of any type: private chats with the user, groups, or channels. The resulting invoice message will look like this:
-Bot Invoice
B. Inline Invoice
-If @merchantbot supports inline mode, you can use inputInvoiceMessageContent to allow users to share invoices for your goods and services to their one-on-one chats with friends, or to their groups and channels. These invoices will have a Pay button that can be used multiple times.
Inline Invoice
2. Choose Forwarding Behavior
-As of Payments 2.0 there are two ways for handling forwarded copies of your invoices, controlled by the parameter start_parameter in the sendInvoice method.
--
-
- A. Multi-chat invoice. Forwarded copies show a Pay button, which multiple users can press and attempt to pay for the goods or services. Inline invoices are always multi-chat invoices. -
- B. Single-chat invoice. Invoice can only be paid from the chat to which it was sent, forwarded copies show a URL button with a deep link to the bot. The deep link can be used to generate a similar invoice in the chat with the bot, to show an error message, or for other purposes. More info on Deep Linking » -
If a single-chat invoice is sent to the chat with @merchantbot, it can only be paid once. If a single-chat invoice is sent to any other chat, it can be paid many times by many users.
--To get a better understanding of how this works, try toggling the “Pay from Forwards” parameter when creating invoices with our demo @ShopBot.
-
Regardless of whether or not the Pay button is available in an invoice, the merchant bot always has the power to decide whether or not to accept new payments for a particular invoice.
-3. Tips (optional step)
-If the max_tip_amount parameter is set to above 0, users can add a tip to their payment. You can use the parameter suggested_tip_amounts to suggest particular amounts that you feel will be relevant for the invoice.
Adding Tips
4. Shipping info and other details (optional step)
-The user specifies shipping information or other info requested by the bot. This could be the user's full name, an email address, a phone number in international format, or a full postal address for delivery.
-Shipping Info
5. Offer delivery options based on shipping address (optional step)
-If a shipping address was requested and you included the parameter is_flexible, the Bot API will send an Update with a shipping_query field to the bot. The bot must respond using answerShippingQuery either with a list of possible delivery options and the relevant delivery prices, or with an error (for example, if delivery to the specified address is not possible).
---Tip: It is recommended that the merchant bot confirms availability of the goods/services at this step – to let the user know in case they are no longer available. This is especially important if you are using multi-chat, inline or single-chat, multi-use invoices.
-
6. Select delivery option (optional step)
-The user selects a delivery option from the list (the overall amount to be paid may change at this point) and proceeds to checkout.
-Choose Delivery Option
7. Pre-Checkout
-The user enters their payment information and presses the final pay button. At this moment the Bot API sends an Update with the field pre_checkout_query to the bot that contains all the available information about the order. Your bot must reply using answerPrecheckoutQuery within 10 seconds after receiving this update or the transaction is canceled.
-The bot may return an error if it can't process the order for any reason. We highly recommend specifying a reason for failure to complete the order in human readable form (e.g. "Sorry, we're all out of rubber ducks! Would you be interested in a cast iron bear instead?"). Telegram will display this reason to the user.
---Warning: As of Payments 2.0, it is critical to make sure your bot only accepts multiple payments when the order can be processed correctly. This is especially important if you are using multi-chat, inline or single-chat, multi-use invoices.
-
8. Checkout
-In case the bot confirms the order, Telegram requests the payment provider to complete the transaction. If the payment information was entered correctly and the payment goes through, the API will send a receipt message of the type successful_payment from the user. Once your bot receives this message, it should proceed with delivering the goods or services purchased by the user.
-If the invoice message was sent in the chat with @merchantbot, it becomes a Receipt in the UI for the user — they can open this receipt at any time and see all the details of the transaction:
Receipt
If the message was sent to any other chat, the Pay button remains and can be used again. It is up to the merchant bot whether to actually accept multiple payments.
-Going Live
-Once you've tested everything and confirmed that your payments implementation works, you're ready to switch to LIVE MODE. To do this, go to BotFather > /mybots > select @merchantbot > Bot Settings / Payments and enable Stripe LIVE MODE. You will get a token that has the string :LIVE: in the middle, e.g. 123:LIVE:XXXX. Do not give this token to any third parties!
Before your merchant bot goes into live mode, please ensure the following:
-Live Checklist
--
-
- We highly recommend turning on 2-step verification for the Telegram account that controls your bot. -
- You as the bot owner have full responsibility in case any conflicts or disputes arise. You must be prepared to correctly process disputes and chargebacks (in the case of Stripe, see here). -
- To prevent any misunderstandings and possible legal issues, make sure your bot can respond to a /terms command (or offers a similarly easy way of accessing your Terms and Conditions). Your Terms and Conditions should be written in a clear way and easy to understand for your users. The users must confirm that they have read and agree to your terms before they make the purchase. -
- Your bot must provide support for its customers, either by responding to a /support command or by some other clearly communicated means. Users must have a clear way of contacting you about their purchases and you must process their support requests in a timely fashion. You must notify your users that Telegram support or bot support will not able to help them with purchases made via your bot. -
- Make sure that your server hardware and software is stable. Use backups to make sure that you don't lose data about your users' payments. -
- Make sure that you have completed the live checklist for your selected payments provider as well as this one. -
-
FAQ
-How do I join as a payment provider?
-If you work for a company that provides services similar to standalone accounts in Stripe Connect, please let us know via @BotSupport (kindly include the hashtag #paymentsprovider in your message).
How much do you charge?
-Telegram does not charge any commission for using the Payments API. Note though, that most payment providers will have their own commissions. For example, Stripe in the US charges 2.9% + 30¢ per successful card charge (see the Stripe website for more details on pricing).
-Do I need a bot to accept payments?
-Yes. If you are not a developer, you will need to either hire someone to make a bot for you (recommended), or use a bot created by a third-party company. We advise extreme caution when using services of bots that process payments for you – Telegram doesn't maintain any such bots and doesn't endorse any of the third-party bots offering these services.
-What can my bot sell?
-Telegram does not impose any limits on what products or services your bot can offer. But please note that you must comply with the rules of the payments provider you choose in our system. E.g., Stripe has a special page for prohibited businesses – you may want to consult that one before you start selling harvested organs.
-Special Note: Due to Apple's limitations, bot developers are currently not allowed to accept payments for digital goods and virtual services from iOS users.
-How are disputes handled?
-Telegram acts as a messenger between the paying user, the bot developer, and their chosen payment system. The user sends their credit card details directly to the payment system. Then the payment system's response and the shipping details entered by the user are passed to the bot developer so that they can process the order.
-Since Telegram doesn‘t process the payments, we don’t store and can‘t access any sensitive data. Due to this structure, it is impossible for Telegram to handle complaints or cashbacks – any disputed payments are the responsibility of the bot developers, payment providers, and banks that participated in the exchange.
---See also: Telegram Privacy Policy
-
How do I support payments in my third-party app that uses the Telegram API?
-You are welcome to study the MTProto payment documentation.
-Supported Currencies
-Telegram payments currently support the currencies listed below (here's a JSON version in case you need it).
-If you're using Stripe as the payments provider, supported currencies may vary depending on the country you have specified in your Stripe account (more info).
-The minimum and maximum amounts for each of the currencies roughly correspond to the limit of US$ 1-10000. The amount must be expressed in 12 digits or less, so the maximum value will be correspondingly lower for some lower-value currencies. Note that for each currency except USD these limits depend on exchange rates and may change over time (plan ahead for this when you implement limits in your code).
| Code | -Title | -Min amount | -Max amount | -
|---|---|---|---|
| AED | -United Arab Emirates Dirham | -AED 3.67 | -AED 36,730.15 | -
| AFN | -Afghan Afghani | -AFN88.35 | -AFN883,589.85 | -
| ALL | -Albanian Lek | -116,15ALL | -1.161.583,07ALL | -
| AMD | -Armenian Dram | -464.91 AMD | -4,649,159.99 AMD | -
| ARS | -Argentine Peso | -ARS 117,25 | -ARS 1.172.572,36 | -
| AUD | -Australian Dollar | -AU$1.44 | -AU$14,496.12 | -
| AZN | -Azerbaijani Manat | -1,69 AZN | -16 950,79 AZN | -
| BAM | -Bosnia & Herzegovina Convertible Mark | -1,88 BAM | -18.842,47 BAM | -
| BDT | -Bangladeshi Taka | -BDT 87.20 | -BDT 872,042.12 | -
| BGN | -Bulgarian Lev | -1,87 BGN | -18 786,43 BGN | -
| BND | -Brunei Dollar | -BND1,40 | -BND14.023,17 | -
| BOB | -Bolivian Boliviano | -BOB 6,91 | -BOB 69.129,76 | -
| BRL | -Brazilian Real | -R$ 5,13 | -R$ 51.347,52 | -
| CAD | -Canadian Dollar | -CA$1.30 | -CA$13,006.30 | -
| CHF | -Swiss Franc | -1.00 CHF | -10'006.02 CHF | -
| CLP | -Chilean Peso | -CLP 865 | -CLP 8.656.598 | -
| CNY | -Chinese Renminbi Yuan | -CN¥6.77 | -CN¥67,799.03 | -
| COP | -Colombian Peso | -COP 4.110,49 | -COP 41.104.900,00 | -
| CRC | -Costa Rican Colón | -CRC673,32 | -CRC6.733.271,35 | -
| CZK | -Czech Koruna | -23,94 CZK | -239 490,10 CZK | -
| DKK | -Danish Krone | -7,14 DKK | -71482,29 DKK | -
| DOP | -Dominican Peso | -DOP55.36 | -DOP553,681.62 | -
| DZD | -Algerian Dinar | -DZD 146.28 | -DZD 1,462,829.90 | -
| EGP | -Egyptian Pound | -EGP 18.31 | -EGP 183,167.98 | -
| EUR | -Euro | -0,96 € | -9 606,30 € | -
| GBP | -British Pound | -£0.81 | -£8,184.70 | -
| GEL | -Georgian Lari | -3,03 GEL | -30 349,69 GEL | -
| GTQ | -Guatemalan Quetzal | -GTQ7.71 | -GTQ77,117.37 | -
| HKD | -Hong Kong Dollar | -HK$7.84 | -HK$78,499.50 | -
| HNL | -Honduran Lempira | -HNL 24.69 | -HNL 246,905.02 | -
| HRK | -Croatian Kuna | -7,22 HRK | -72.266,02 HRK | -
| HUF | -Hungarian Forint | -369,24 HUF | -3 692 459,93 HUF | -
| IDR | -Indonesian Rupiah | -IDR14.627,55 | -IDR146.275.500,00 | -
| ILS | -Israeli New Sheqel | -₪ 3.40 | -₪ 34,077.15 | -
| INR | -Indian Rupee | -₹77.30 | -₹773,028.50 | -
| ISK | -Icelandic Króna | -134 ISK | -1.341.900 ISK | -
| JMD | -Jamaican Dollar | -JMD156.22 | -JMD1,562,260.95 | -
| JPY | -Japanese Yen | -¥128 | -¥1,288,124 | -
| KES | -Kenyan Shilling | -KES116.15 | -KES1,161,500.66 | -
| KGS | -Kyrgyzstani Som | -82-67 KGS | -826 741-00 KGS | -
| KRW | -South Korean Won | -₩1,280 | -₩12,809,399 | -
| KZT | -Kazakhstani Tenge | -KZT436-24 | -KZT4 362 469-77 | -
| LBP | -Lebanese Pound | -LBP 1,520.53 | -LBP 15,205,348.80 | -
| LKR | -Sri Lankan Rupee | -LKR 372.04 | -LKR 3,720,444.32 | -
| MAD | -Moroccan Dirham | -MAD 10.15 | -MAD 101,544.33 | -
| MDL | -Moldovan Leu | -19.05 MDL | -190,547.12 MDL | -
| MNT | -Mongolian Tögrög | -MNT3 048,80 | -MNT30 488 015,99 | -
| MUR | -Mauritian Rupee | -MUR42.99 | -MUR429,952.60 | -
| MVR | -Maldivian Rufiyaa | -15.45 MVR | -154,501.97 MVR | -
| MXN | -Mexican Peso | -MX$20.17 | -MX$201,746.60 | -
| MYR | -Malaysian Ringgit | -MYR4.39 | -MYR43,925.02 | -
| MZN | -Mozambican Metical | -MZN63.82 | -MZN638,298.64 | -
| NGN | -Nigerian Naira | -NGN415.32 | -NGN4,153,299.95 | -
| NIO | -Nicaraguan Córdoba | -NIO 36.01 | -NIO 360,151.26 | -
| NOK | -Norwegian Krone | -NOK 9,84 | -NOK 98 411,98 | -
| NPR | -Nepalese Rupee | -NPR124.63 | -NPR1,246,332.83 | -
| NZD | -New Zealand Dollar | -NZ$1.59 | -NZ$15,994.00 | -
| PAB | -Panamanian Balboa | -PAB 1.00 | -PAB 10,055.01 | -
| PEN | -Peruvian Nuevo Sol | -PEN 3.80 | -PEN 38,084.18 | -
| PHP | -Philippine Peso | -PHP52.40 | -PHP524,060.26 | -
| PKR | -Pakistani Rupee | -PKR192.81 | -PKR1,928,113.26 | -
| PLN | -Polish Złoty | -4,48 PLN | -44 881,20 PLN | -
| PYG | -Paraguayan Guaraní | -PYG 6.914 | -PYG 69.149.028 | -
| QAR | -Qatari Riyal | -QAR 3.64 | -QAR 36,407.50 | -
| RON | -Romanian Leu | -4,75 RON | -47.515,99 RON | -
| RSD | -Serbian Dinar | -112,94 RSD | -1.129.409,05 RSD | -
| RUB | -Russian Ruble | -62,91 RUB | -629 149,79 RUB | -
| SAR | -Saudi Riyal | -SAR 3.75 | -SAR 37,509.37 | -
| SEK | -Swedish Krona | -10,09 SEK | -100.994,11 SEK | -
| SGD | -Singapore Dollar | -SGD1.39 | -SGD13,943.95 | -
| THB | -Thai Baht | -฿34.74 | -฿347,460.62 | -
| TJS | -Tajikistani Somoni | -12;54 TJS | -125 440;76 TJS | -
| TRY | -Turkish Lira | -15,46 TRY | -154.615,25 TRY | -
| TTD | -Trinidad and Tobago Dollar | -TTD6.83 | -TTD68,331.10 | -
| TWD | -New Taiwan Dollar | -NT$29.79 | -NT$297,952.99 | -
| TZS | -Tanzanian Shilling | -TZS2,324.99 | -TZS23,249,998.70 | -
| UAH | -Ukrainian Hryvnia | -29,71UAH | -297 124,66UAH | -
| UGX | -Ugandan Shilling | -UGX3,622 | -UGX36,228,323 | -
| USD | -United States Dollar | -$1.00 | -$10,000.00 | -
| UYU | -Uruguayan Peso | -UYU 41,90 | -UYU 419.006,15 | -
| UZS | -Uzbekistani Som | -11 227,61 UZS | -112 276 129,83 UZS | -
| VND | -Vietnamese Đồng | -23.091 ₫ | -230.915.000 ₫ | -
| YER | -Yemeni Rial | -YER 250.24 | -YER 2,502,498.91 | -
| ZAR | -South African Rand | -ZAR 16.03 | -ZAR 160,303.39 | -