Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Notification API

Notification API is required for merchants to notify users. Sends a notification to the customer before the mandate transaction is exercised. A notification has to be sent to the user at least 24 hours and no more than 48 hours before the execution of the mandate. This API is called using the mandate_id  generated during creation of the mandate.

  Response Parameters  for the Notification API:   (click to view)
Note:
Response parameters are the same as for the Notification Status API.
ParameterTypeDescription
idStringUnique identifier provided by Juspay.   i.e. “18"
source_objectStringSource object for notification.   i.e. “MANDATE”
source_object_idStringSource object for notification. mandate_id in this case.
i.e. "92025"
This should be added to response list, since it is shown in actual response.
objectStringMust be set to "notification"
This should be added to response list, since it is shown in actual response.
object_reference_idStringUnique Identifier passed in the request.   I.e. "1234578"
provider_nameStringName of the provider. Gateway name in this case
I.e. "PAYTM_V2"
notification_typeStringType of notification.   I.e. “SMS”
descriptionStringReason for debit passed in the request
statusStringStatus of Notification. Must be one of these four states:
CREATED - Created and not yet initiated to gateway
PENDING - Initiated to gateway
SUCCESS - Success from gateway
FAILURE - Failed from gateway
date_createdStringDate-time of notification created in UNIX EPOCH timestamp (UTC timezone) format.
i.e. "1598960071"
last_updatedStringDate-time of notification updated in UNIX EPOCH timestamp (UTC timezone) format.
i.e. "1598960071"
metadataStringMetadata passed in the request
mandate:
   {mandate_id}
Object
String
 Same as mandate id provided in the request:
 i.e. "mandate_id": "92025"
source_info:wwiwww
   {amount, txn_date}
Object
String
 Same as amount and txn_date passed in the request
 i.e. "amount": "100.00",
"txn_date": "2020-07-15 15:00"
provider_response:
   {provider_ref_id,
   notificationDate}
Object
String
String
provider_ref_id: Reference Number provided by
 downstream gateway   i.e.
"provider_ref_id": "31413"
notificationDate: Date on which notification was sent.   I.e.
"notificationDate": "2020-07-15 15:00"
Specific to PAYTM_V2
Note:
Dates for txn_date and notificationDate are formatted as: YYYY-MM-DD HH:MM
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!