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.

📘

Note:

Length up to 25 alphanumberic characters are only accepted.

  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. "1957069"
source_objectStringSource object for notification.
i.e. “MANDATE”
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 - Notification created in Juspay System, but not yet initiated to gateway
PENDING - Initiated to the Payment Gateway, and awaiting the notification status from gateway
SUCCESS - Success from gateway
FAILURE - Failed from gateway
date_createdDate
Time
Date-time of notification created in UNIX EPOCH timestamp (UTC timezone) format.
i.e. "1598960071"
last_updatedDate
Time
Date-time of notification updated in UNIX EPOCH timestamp (UTC timezone) format.
i.e. "1598960071"
metadataStringMetadata passed in the request
mandate:
     {mandate_id}
Object
String
 Mandate ID provided in the request:
 i.e. "4rKxSj3bNXs7RQcdtajAkb"
source_info:
    {param1, param2,...}
ObjectJSON block of source info provided in the request.
  Parameters for the source_info object:
      (click to open)
amountStringAmount passed in the request.
i.e. "100.00"<
txn_dateDate
Time
txn_date passed in the request.
Format: UNIX EPOCH timestamp (UTC timezone).
i.e. "1634057114"
mandate.display_invoice_numberStringThe display invoice number that was passed in the request.
i.e. "INVN67Mzd6wMX4xPVBC"
provider_response:
    {param1, param2}
ObjectJSON block of response from gateway.
  Parameters for the provider_response object:
      (click to open)
provider_ref_idStringReference Number provided by downstream gateway.
i.e. "IN0DF815118772"
notification_dateDate
Time
Date on which notification was sent by downstream gateway.
I.e. "1634057114"
Specific to PAYTM_V2
The request must include  mandate_id, object_reference_id, and other parameters, as listed below:
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!