Integration Guidelines

Mini Apps have a few broad platform expectations from Merchants to ensure a seamless experience for our end user and would like every 3rd party merchant to adhere to these practices.

  1. The end-user must be able to sign-in into Merchant Mini Apps only through the Paytm sign-in flow. There should be no other modes of login like manual user input based login method or social login.
  2. Payment mode in Mini Apps should only be via. paytmPayment JS API and no other payment modes should be visible at any point in the app flow.
  3. Merchants should not send promotional messages by leveraging Notification API.Violation of this will lead to blacklisting of Merchant Notifications.
  4. There must be no link in the Mini Apps redirecting the user to download Android/iOS app. No user redirection out of Mini Apps or the Paytm environment  is allowed.
  5. Any post transaction / follow up communication to engaged users (transacting / non transacting) must lead to the Paytm Mini App, if any redirection link is included.
  6. It is recommended that Merchants have a well defined Customer Service flow in Mini Apps.
  7. In Android to get geolocation use paytmCheckPermission to check for "location" Permission & paytmRequestPermission to request "location" permission in case it is not granted, post that merchant can use web-based code to get the location.
  8. If the flow of your Mini App requires a user to add his / her address, the Paytm SelectAddress bridge must be integrated. This can be found under the Additional APIs section.
  9. Before calling any JS API that requires permissions, merchants must use paytmCheckPermission to check a permission & paytmRequestPermission to request a permission in case it is not granted, post that call the required JS API only if permission is available.
  10. If you have a monetization model via third party ads, please get in touch with your Paytm Key Account Manager to understand more about the integration and revenue guidelines, or drop us an email