• Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Testing
      Refunds
      Guides
      Other Processes
      Mini Program Platform
        Website Integration

      sendPartnerNotification API

      Use Case


      This API gives merchant the ability to send templatised Notifications to the user. The Notifications are delivered as Paytm App Notifications to the end user. These notifications are only allowed for post order related use cases.


      Request Attributes

      API Content format: JSON

      Request Attributes

      ParameterDescriptionRequiredExample Value
      clientIdYour client id received from paytmYesmarket-app-staging
      openIdOpen ID generated by paytm by calling paytmFetchAuthCode JS APIYesMjjpptrGTFUN6bm2Is0tEBp6vpQXGxw71hxgbofvXK4
      orderIdUnique reference ID for a transaction which is generated by merchant and sent in the requestYes0071570611491142
      templateNameTemplate NameYesh5-demo-notify
      midThis is a unique identifier provided to every merchant by PaytmYescqxpFk55774655560618
      notificationPayload.textDynamic text to be sent as a part of notificationYesYour order is out for delivery
      notificationPayload.urlDeeplink URL to be sent in NotificationYespaytmmp://mini-app?aId=05f4b836f67219b3b4d4f2ba9fb3631c0fd49988

      Response Attributes

      Success:

      ParameterDescriptionExample Value
      codeResponse CodeSR_2000
      statusResponse StatusSUCCESS
      messageResponse MessageYour request has been processed successfully...!!!
      responseNotification Response(Notification job id)183-6843-116387887752-970586694

      Error Responses:

      ParameterDescriptionExample Value
      coderesponse codeER_4500
      statusresponse statusFAILURE
      messageresponse messageInvalid Client
      displayMessagedisplay messageWe are unable to process your request. Please try again after some time

      ERROR CODES

      Response CodeStatus
      ER_4500Invalid Client
      ER_4501Invalid Token
      ER_4215Notification API failed Too Many Request received
      ER_4212Max Notification Limit Reached","displayMessage


      Endpoints

      Staging: https://miniapps-staging.paytm.com/h5/notify/v1/sendPartnerNotification

      Production: https://miniapps.paytm.com/h5/notify/v1/sendPartnerNotification

      Request CodeResponse JSON
      curl -X POST 'https://miniapps-staging.paytm.com/h5/notify/v1/sendPartnerNotification'  
                 --header 'Content-Type: application/json'            --header 'cache-control: no-cache'            --header 'postman-token: e001fcf3-ca21-c976-98fe-761e7ab7de76'            --data-raw '{"clientId":"market-app-staging","openId":"MjjpptrGTFUN6bm2Is0tEBp6vpQXGxw71hxgbofvXK4=","orderId":"0071570611491142","templateName":"h5-demo-notify","mid":"cqxpFk55774655560618","notificationPayload":{"text":"Your order is out for delivery","url":"paytmmp://mini-app?aId=05f4b836f67219b3b4d4f2ba9fb3631c0fd49988"}}'