paytm developer docs logoDeveloperDocumentation
search

Step by Step Integration Guide

Easy 4 step Integration Process!

You’ll need to go through the following 4 steps before you can take your app live on the Mini App Store: 

  1. Onboard
  2. Develop and Integrate
  3. App Review and QA
  4. Take your App Live!
     

Step 1: Onboard

There are two ways to onboard with us at Paytm Mini Apps :

Note: You can find the documentation required for onboarding with us here.

 

Which onboarding method is best for me?

 

If you’re having an existing enterprise business relationship with Paytm for an online or offline solution, or are already in touch with our Key Account Managers, you may reach out to us directly for an enterprise account management for your Mini App requirement on miniapp.support@paytm.com.
 
Else, you can use the quick and seamless DIY Flow, and start building your Mini App through our Paytm Business Dashboard

 

Methods for Onboarding

Visit the Paytm Business Dashboard to register yourself for a Mini App account. Please refer to this video to understand how to onboard your Mini App using the Do-It-Yourself flow.

Post onboarding you will get the following details:

  • App QR : This will be used to open the development app required for integration
  • Mini App ID: This is the unique App Id for your Mini App. You will need this id for any interactions with the Paytm ecosystem.
  • Auth client ID and client secret: These are required for login flow integration for your Mini App.
  • PG MID and key: These are required for payment flow integration for your Mini App.
Note: PG MID and key are required for collecting payments in the mini apps and will be available after registering as an unlimited merchant. The option to register for an unlimited merchant account is available on Mini Apps details page on the business dashboard.


Mini Apps

Post successful onboarding, scan the QR code present on the Business Dashboard using the Paytm android app. This will open the Developer Mini App that you can use to configure, intergrate and publish your app. You can learn more about how to use the Developer Mini App here.

To get yourself onboarded manually system, you can get in touch with one of our Key Account Managers. Please fill out this form with some basic details and one of our account managers will get in touch with you in no time! Looking forward to having you onboard!
 
Just to give you an idea of the process involved :

  1. Our teams will be going through the flow of your website and perform some basic documentation checks as part of the onboarding process.
  2. Once this is approved, a digital agreement will be sent to you for signing, thereby completing your onboarding.
  3. You’ll then be issued a Merchant ID (MID) under which all the transactions happening under your Mini App will be clocked. You can thus access transactions data and analytics by logging in to your Paytm Business Dashboard. This MID is separate from any other MID you may be using on a different Paytm Payment Gateway on your website or app. We’ll also send out other credentials required for you to move on to the next step, and begin Integration!
    • App QR : will be used to open the development app required for integration. This will be sent to your email address along with other steps required for you to configure your App. Once you receive your QR, you can learn more about how to use the Developer Mini App here.
    • PG MID and key: These are required for payment flow integration for your Mini App. You can find them by logging in to your Paytm Dashboard.
       
    • Auth client ID and client secret: These are required for login flow integration for your Mini App. These will be sent to your email address.
    • Mini App ID: This is the unique App Id for your Mini App. You will need this id for any interactions with the Paytm ecosystem.

 

Credential

 Sample Value Usage

PG MID

 Cxxxxk5x02xxxxxxxxx1 Payments Flow

Merchant Key

 Z1xxxxxxxxxxxxxs Payments Flow

Client ID

 merchant-xxxxxx-xxxx or random alphanumeric Login Flow

Client Secret / Client Name

 Rxxxxxx88Y790xxx3HvP4LOwAfI7zxxxx Login Flow

 

Step 2: Develop & Integrate

To onboard as Mini Apps, there are the following API integration merchants need to implement:

 

Mandatory Integrations Additional API Integrations to make your Mini App feature rich

Note: Your Mini app can not have any other login or payment methods other than the one's specified above. Using Login or Payment flow is optional depending on your app's use case.

Please ensure that your app abides by the integration checklist as detailed here

 

Login (Consent) Flow

Payments Flow

 

Apart from these, we have other APIs such as the Notifications API that can be found here

Step 3: App Review and QA

Once you have completed the integration submit your app to Paytm team for review.This can be done through the 'Developer Mini App'

  • App Review

    • Tap on 'App Submission' on Developer Mini App home page to open the app submission workflow.
    • Ensure that the requirements as laid out on the disclaimer page are adhered to and accept these to continue with the review submission.
    • Provide the confirmation on the submission checklist.
    • Tap on 'Submit your app'.
    • Feedback against your app submission (if any) will be shown in the developer mini-app. Once you have addressed all the feedbacks, resubmit the app for review as outlined above.

Step 4: Go Live

  • Go-Live

    • Tap on 'Take your app live'.
    • A summary screen with your mini app details will be shown.
    • Tap on 'Submit your app for Go-live'.
    • Congrats! Your go-live request is registered. Your app will be made post a final sanity test by the Paytm team in the next 1-2 working days.