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, Gocashfree, PhonePe the notification is taken care at PG end.
Note
Length upto 25 and alphanumeric characters are only accepted.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/mandates/{mandate_id}
Production Link
POST
https://api.juspay.in/mandates/{mandate_id}
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
Content-Type
String
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Path Params
mandate_id
*
String
Mandatory
Mandate Id
Example:- b70vxxxxxjGyUhVrV8
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
amount
*
string
Mandatory
Amount for which notification is to be sent to customer I.e. 100.00
txn_date
*
string
Mandatory
Date on which debit is intended to happen in UNIX EPOCH timestamp (UTC timezone) format
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
To be passed as Stringified JSON
key1
String
Any key value pair can be passed and will be returned in response
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.
notification_date
String
Date on which notification has been sent by downstream gateway.
Format: UNIX EPOCH timestamp (UTC timezone).
I.e. 1634057114
Specific to PAYTM_V2
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