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.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/txns
Production Link
POST
https://api.juspay.in/txns
Authorization Header
Basic Auth
*
required
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
Content-Type
*
String
Mandatory
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
Request Schema: application/json
Parameters
order.order_id
*
String
Mandatory
Unique Identifier for the order.
order.amount
*
String
Mandatory
This is the amount that a customer will be charged in this transaction.
order.customer_id
*
String
Mandatory
Customer Identifier against which the mandate was created.
merchant_id
*
String
Mandatory
The username you hold at Juspay
mandate_id
*
String
Mandatory
Mandate ID sent by Juspay after successful mandate registration.
mandate.execution_date
String
UNIX EPOCH timestamp format. This is for merchants only where Juspay manages the notifications. 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 mandate flows which doesnt require notification, like Net Banking ,Wallet etc., where mandate execution occurs once the merchant sends the request.
Warning
For gateways handling notifications (e.g., Razorpay, PhonePe, Cashfree), execution follows the gateway's policy.
format
*
String
Mandatory
The format of the response. Should be passed as json.
200 : Success
Response Body
UPI Collect/Card/NB
JSON
txn_uuid
String
txn_id
String
Transaction ID for the payment attempt.
status
String
Status of the transaction. PENDING_VBV indicates that the transaction requires authentication to complete.
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
order_id
String
Unique Identifier for the order.
UPI Intent
JSON
txn_uuid
String
txn_id
String
Transaction ID for the payment attempt.
status
String
Status of the transaction. PENDING_VBV indicates that the transaction requires authentication to complete.
payment
Object
sdk_params
object
uri_params
object
validitystart
String
validityend
String
tr
String
tn
String
tid
String
recur
String
purpose
String
pn
String
pa
String
orgid
String
mode
String
mn
String
mc
String
cu
String
amrule
String
am
String
scheme
String
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
order_id
String
offer_details
object
offers
array
Have questions?
- Need help? Contact support
- LLM? Read llms.txt