paytm developer docs logoDeveloperDocumentation
search

Subscription activation - QR Code

Demo

Overview

  1. Once a customer selects a plan, you create a subscription order with Paytm, and get the Transaction Token and subscription id.
  2. In FPO, pass deepLinkRequired as True to get UPI QR deeplink.
  3. Convert this deep-link or QR image data into a QR image using any QR generator tool/function.
  4. Display the QR to your customer on your platform (Website/ TV app) to scan using the Paytm or any UPI app.
  5. The customer enters the payment details to complete the authorization on Paytm or any UPI App.
  6. Use the Subscription S2S Callback or Fetch Subscription Status API to confirm the subscription status and display the confirmation to the user on your TV App.

Integration Steps

  1. Generating the deep link and QR

    To generate a deeplink:

     

    i. Pass deepLinkRequired as True in the request of Fetch Payment Option API, as a result of which a deeplink will be shared under “deepLink”.

     

    "deepLink":
    "upi://mandate?pa=paytm-66884131@paytm&pn=Anant%20Test&mc=5699&tid=PYTM20220809365804738747&tr=PAYTMSUBS20220809365804738747&tn=Amount%20to%20be%20paid%20now%20is%20Rs%208000.00&am=15000.00&mam=8000.00&cu=INR&mode=00&purpose=14&orgid=000000&validitystart=09082022&validityend=31082022&amrule=MAX&recur=MONTHLY&recurvalue=9&recurtype=AFTER&mn=Subscription%20for%20AnantTest&rev=Y"

     

    ii. Convert the deep-link/QR data into a QR image and display it on your platform (website / TV app). There are open libraries available online which can be used to convert the QR deeplink/UPI QR image data into the QR image.

     

     Caution : You need to take care of the following points while generating and displaying QR image:
    • The "deepLink" parameter value must be used for generating QR.
    • The QR image must be displayed on white background.
    • The size of the UPI QR image must be at least 1.5"x1.5" for faster scan.
    • A white space of width 0.5 inch must be left around the QR image.
     

  2. Subscription authorisation and payment completion

    Thereafter, the customer scans the QR from the Paytm or any UPI app to complete the subscription activation and the first payment.

  3. Fetching the latest subscription status

    After the successful payment, Paytm provides a callback to your server. Alternatively, you can use the Fetch Subscription Status API to check the status of the subscription and display the confirmation on your platform (Website / TV app) accordingly.