Body
Notification API
This API is required if mandate notification is handled at merchants end. This sends a notification to the customer before the mandate transaction is exercised. A notification has to be sent to the user 24 hours before the execution of the mandate. This API is called using the mandate_id generated while creation of mandate. In case of Razorpay and Gocashfree the notification is taken care at PG end.
Note
Length upto 25 and alphanumeric characters are only accepted.
Request
Response
API Endpoints
Production Link
POST
https://sandbox.juspay.in/mandates/{mandate_id}
Parameters
command
*
string
Mandatory
“pre_debit_notify” for sending notification before execute mandate
object_reference_id
*
string
Mandatory
Merchants unique Identifier for the request.
source_info
object
Json block to pass detailed information to gateway
source_info.amount
string
Amount for which notification is to be sent to customer I.e. 100.00
source_info.txn_date
string
Date on which debit is intended to happen in UNIX EPOCH timestamp (UTC timezone) format
source_info.mandate
object
display_invoice_number
String
If merchant wants to generate invoice display number, this needs to be passed in notification call. If not passed, Juspay will create a unique invoice number and pass it to downstream system. It should be alphanumeric and length upto 25 characters. (Applicable only for cards SI)
description
*
string
Mandatory
Reason for debit that will be sent to user - Max Length: 50
metadata
string
For future use case
200 : Success
Response Body
status
string
Status of Notification
CREATED/PENDING/SUCCESS/FAILURE
CREATED- Created and not yet initiated to gateway
PENDING- Initiated to gateway
SUCCESS- Success from gateway
FAILURE- Failed from gateway
source_object
string
Source object for notification. i.e. “Mandate”
source_info
object
Json block of source info provided in the request
txn_date
string
txn_date passed in the request.
Format: UNIX EPOCH timestamp (UTC timezone).
I.e. 1634057114
amount
string
Amount passed in the request.
I.e. 100.00
mandate.display_invoice_number
String
The display invoice number that is passed in the request.
provider_response
object
Json block of response from gateway
provider_ref_id
string
Reference Number provided by downstream gateway.
provider_name
string
Name of the provider. Gateway name in this case
I.e. PAYTM_V2
object_reference_id
string
Unique Identifier passed in the request.
I.e. 1234578
object
string
notification
notification_type
string
Type of notification.
I.e. “SMS”
mandate
object
Json block for Mandate ID provided in the request:
mandate_id
String
Mandate id provided in the request
last_updated
string
Date-time of notification updated in UNIX EPOCH timestamp (UTC timezone) format
id
string
Unique identifier provided by Juspay
description
string
Reason for debit passed in the request
date_created
string
Date-time of notification created in UNIX EPOCH timestamp (UTC timezone) format
400 : Invalid Input data
Response Body
Duplicate Object Reference ID
JSON
user_message
String
type
String
session_id
String
message
String
code
String
Invalid Mandate ID
JSON
status
String
error_message
String
error_code
String