Body
Mandate Execution API
After the successful Mandate registration, Merchant will receive a mandate_id, mandate_token from Juspay that should be stored against a customer at their end. For the subsequent charge transactions, the merchant is supposed to pass a combination of customer_id and mandate_id to do a debit without a 2FA. This API will create an order and perform a transaction with PG based on the mandate_id passed in the request.
Scroll inside to view more
|
Status code
|
Reason
|
Response
|
|---|---|---|
JP_851
| Notification Leg of the transaction failed.
| PDN Failed.
|
JP_852
| Mandate is not in active State
| |
401
| Invalid Authentication
| { "status": "error", "error_code": "access_denied" }
|
400
| Duplicate order id
| { "status_id": 40, "status": "DUPLICATE_ORDER_ID", "error_message": "Order already exists with the given order_id" }
|
400
| Invalid order amount
| {"status":"Invalid Request","error_message":Invalid order amount","error_code":"Invalid"}
|
400
| Mandate max amount not found
| {"status":"Invalid Request","error_message":"Mandate max amount not found.","error_code":"Invalid"}
|
400
| Amount not found in request.
| {"status":"Invalid Request","error_message":"Amount not found in request.","error_code":"Invalid"}
|
400
| Order amount greater than mandate max amount
| {"status":"Invalid Request","error_message":"Order amount greater than mandate max amount (
|
400
| Order amount not equal to mandate max amount.
| {"status":"Invalid Request","error_message":"Order amount not equal to mandate max amount.","error_code":"Invalid"}
|
400
| Currency not valid for mandate transaction
| {"status":"Invalid Request","error_message":"currency not valid for mandate transaction.","error_code":"Invalid"}
|
400
| notification_id not found in request.
| {"status":"Invalid Request","error_message":"mandate.notification_id is mandatory.","error_code":"Invalid"}
|
400
| Notification record not found
| {"status":"Invalid Request","error_message":"Notification record not found for ","error_code":"Invalid"}
|
400
| Notification status is not success
| {"status":"Invalid Request","error_message":"Notification status is not success.","error_code":"Invalid"}
|
400
| Mandate not found
| {"status":"invalid_request_error","error_message":"Mandate not found","error_code":"Mandate not found"}
|
400
| Mandate not in active state
| {"status":"invalid_request_error","error_message":"Mandate is in non active(REVOKED / FAILURE) state. Recurring cannot be executed","error_code":"Mandate is in non active(REVOKED / FAILURE) state. Recurring cannot be executed"}
|
3 columns 16 rows
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/txns
Production Link
POST
https://api.juspay.in/txns
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
Parameters
order
object
first_name
String
first_name is mandatory for certain gateway specific flows
last_name
String
last_name is mandatory for certain gateway specific flows
order_id
*
string
Mandatory
Unique Identifier for the order.
amount
*
string
Mandatory
This is the amount that a customer will be charged in this transaction.
customer_id
*
string
Mandatory
Customer Identifier against which the mandate was created.
currency
string
ISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. Default value: INR
customer_email
string
Email address of the customer. This field is mandatory if gateway requires it.
customer_phone
string
Mobile number or fixed line number of the customer. This field is mandatory if gateway requires it.
description
string
Short description for the order. We send this information to the backend gateways whenever there is a provision for this.
return_url
string
A fully qualified URL such as http://shop.merchant.com/
to which the customer will be redirected after payment completion.
This URL shouldn’t contain any query parameters.
This URL takes higher precedence over the common return URL configured in your account settings.
product_id
string
An identifier for the product on the Lender side for which the payment is being done. This field is just echoed back in the response so that Lender can differentiate on their side.
billing_address_first_name
string
First name in the billing address
billing_address_last_name
string
Last name in the billing address
billing_address_line1
string
Line 1 in the billing address
billing_address_line2
string
Line 2 in the billing address
billing_address_line3
string
Line 3 in the billing address
billing_address_city
string
Billing address city
billing_address_state
string
Billing address state
billing_address_country
string
Billing address country
billing_address_postal_code
string
Billing address postal code or zip code
billing_address_phone
string
Mobile or phone number in the billing address
billing_address_country_code_iso
string
ISO Country code. Default value: IND
shipping_address_first_name
string
First name in the shipping address
shipping_address_last_name
string
Last name in the shipping address
shipping_address_line1
string
Line 1 in the shipping address
shipping_address_line2
string
Line 2 in the shipping address
shipping_address_line3
string
Line 3 in the shipping address
shipping_address_city
string
Shipping address city
shipping_address_state
string
Shipping address state
shipping_address_country
string
Shipping address country
shipping_address_postal_code
string
Shipping address postal code or zip code
shipping_address_phone
string
Mobile or phone number in the shipping address
shipping_address_country_code_iso
string
ISO Country code. Default value: IND
udf1
string
udf2
string
udf3
string
udf4
string
udf5
string
udf6
string
udf7
string
udf8
string
udf9
string
udf10
string
gateway_id
string
Specify your preferred gateway for this order. Complete mapping for gateway_id can be found here: Gateway mapping
metadata
object
BILLDESK:AdditionalInfo1
String
BILLDESK:AdditionalInfo2
String
mutual_fund_details
List
Optional
Contains the details of Mutual Fund.
memberId
*
String
Mandatory
Member Id with ICCL or ARN_RIA with RTA.
userId
*
String
Mandatory
Client Id with ICCL or USER_CODE with RTA.
mfPartner
*
String
Mandatory
NSE/BSE/KFIN/CAMS.
orderNumber
*
String
Mandatory
Unique order number of each MF. Oder Number in ICCL or APPL_NO in RTA.
amount
*
String
Mandatory
Individual MF amount within the array of MF being purchased.
investmentType
*
String
Mandatory
LUMPSU/ SIP
folioNumber
String
Optional
Folio Number of the MF, used for RTA reporting. Mandatory for RTA reporting.
panNumber
String
Optional
PAN Number of the user, used for RTA reporting. Mandatory for RTA reporting.
amcCode
String
Optional
AMC Code of the MF, used for RTA reporting. Mandatory for RTA reporting.
schemeCode
String
Optional
Scheme Code of the MF, used for RTA reporting. Mandatory for RTA reporting.
merchant_id
*
string
Required
The username you hold at Juspay
mandate_id
*
string
Required
Mandate ID sent by Juspay after successful mandate registration.
mandate
object
notification_id
string
[CONDITIONAL] The object_reference_id which was sent in notification API call. Applicable only for merchants calling Notification and Execution APIs separately.
display_invoice_number
string
Applicable only for cards SI. If merchant wants to generate invoice display number, but wants Juspay to handle pre-debit notification, this needs to be sent.
execution_date
string
Applicable only for merchants enabled for mandate workflow (notification + execution flow).UNIX EPOCH timestamp format. Default execution happens at 25th hour of successful notification. If a merchant wants to execute mandate at custom time anytime after 25th hour, send execution_date.
Warning
This parameter doesn't apply to gateways handling notifications (e.g. Razorpay, PhonePe, Cashfree), execution follows the gateway's policy
format
*
string
Required
The format of the response. Should be passed as json.
200 : Success
Response Body
txn_uuid
string
Transaction UUID for the payment
txn_id
string
Transaction Id for the payment
status
string
Status of the transaction. See Appendix for status mapping.
payment
object
authentication
object
url
String
URL to which the user has to be taken to for completing the authentication
method
String
HTTP Method for authentication. Can be one of GET or POST
payment.authentication.params
Params Object
Present only when the method is POST. Parameter map that has to be sent along with the URL for authentication.
order_id
string
26234761248249834753485721
offer_details
object
offers
array
400 : Invalid Input data
Response Body
status_id
integer
status
string
DUPLICATE_ORDER_ID
error_message
string
Order already exists with the given order_id