search

Notifications

Mini Apps gives you the functionality to send post payment notification to any of your MinMinMinMini Apps Notifications, you need to hit the Paytm notification service with desired Payload as per the notification template.

Notification Flow

The flow for the notification service is as follow:

  1. You need to make a S2S call from your IP whitelisted server to Notification endpoint using sendPartnerNotification API with following parameters:

    1. clientId
    2. OpenID
    3. Order ID
    4. mid
    5. Template Name
    6. NotificationPayload
  2. Post successful validation of your request, Paytm will send notification to the Paytm user recognised by the OpenId.
  3. There is a limit on the number of Notifications, you can send for any transaction: current limit by default is set to 3 notifications per orderId within a 7 day period.

You need to get Notification template created to be able to send notifications to Paytm user.For the same you need to share your template requirements during onboarding. For template creation you need to share three things;

  1. Deeplink URL (Dynamic URL is also supported).
  2. Static message body.
  3. Dynamic message text

Sample notification template which you can use for testing purposes:

 

Template Name: Miniprogram_test_template_1

Template Example: "{{name}}Your order is out for delivery. It will reach in {{=time}}"

Expected Payload:

{
  "clientId":"your client_id","openId":"MjjpptrGTFUN6bm2Is0tEBp6vpQXGxw71hxgbofvXK4=","orderId":"y0071570611491142","templateName":"Miniprogram_test_template_1","mid":"cqxpFk5577465553618","notificationPayload":{"name":"Dominos","time":"10 minutes","url":"paytmmp://mini-app?aId=05f4b836f67219b3b4d4f2ba9fb3631c0fd49988"}
}

Expected Response: Dominos : Your order is out for delivery. It will reach in 10 minutes