post https://sandbox.juspay.in/mandates/
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.
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier provided by Juspay. i.e. "1957069" |
| source_object | String | Source object for notification. i.e. “MANDATE” |
| object | String | Must be set to "notification"This should be added to response list, since it is shown in actual response. |
| object_reference_id | String | Unique Identifier passed in the request. I.e. "1234578" |
| provider_name | String | Name of the provider. Gateway name in this case I.e. "PAYTM_V2" |
| notification_type | String | Type of notification. I.e. “SMS” |
| description | String | Reason for debit passed in the request |
| status | String | Status 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_created | Date Time | Date-time of notification created in UNIX EPOCH timestamp (UTC timezone) format. i.e. "1598960071" |
| last_updated | Date Time | Date-time of notification updated in UNIX EPOCH timestamp (UTC timezone) format. i.e. "1598960071" |
| metadata | String | Metadata passed in the request |
| mandate: {mandate_id} | Object String | Mandate ID provided in the request: i.e. "4rKxSj3bNXs7RQcdtajAkb" |
| source_info: {param1, param2,...} | Object | JSON block of source info provided in the request. |
Parameters for the source_info object:
(click to open)
| amount | String | Amount passed in the request. i.e. "100.00"< |
| txn_date | Date Time | txn_date passed in the request.Format: UNIX EPOCH timestamp (UTC timezone). i.e. "1634057114" |
| mandate.display_invoice_number | String | The display invoice number that was passed in the request. i.e. "INVN67Mzd6wMX4xPVBC" |
| provider_response: {param1, param2} | Object | JSON block of response from gateway. |
Parameters for the provider_response object:
(click to open)
| provider_ref_id | String | Reference Number provided by downstream gateway. i.e. "IN0DF815118772" |
| notification_date | Date 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: