Body
Mandate Execution API
This API is used to debit amount from the customers account on a recurring basis as per the frequency specified during mandate registration flow. The API creates an order, sends notification to customer informing about upcoming debit and performs a transaction with PG based on the mandate_id passed in the request.
NOTE: Implement this API only when you have use case of Mandates.
Request
Response
API Endpoints
Production Link
GET
https://api.juspay.in/txns
Authorization Header
Basic Auth
*
Base64 Encoded username:password
required
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
string
required
Merchant ID provided by Juspay
Example:-
merchant-id
Request Schema: application/json
Basic Parameters
order.order_id
*
string
required
Unique Identifier for the order. Should be Alphanumeric with character length less than 18.
Example:-
order-id-9876580
order.amount
*
string
required
Amount that the customer has to pay. Will accept stringified double or integer values with upto two decimal places. For example, '100.15' and '100' are valid input but '100.1532' is not valid.
Example:-
1.00
order.customer_id
*
string
required
It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions
Example:-
customer-id-007
mandate_id
*
string
required
It is available in the response of order status api post mandate registration
Example:-
4rKxSj3bNXs7RQcdtajAkb
mandate.execution_date
string
Should be passed in UNIX Epoch timestamp. This is the date on which the mandate has to be executed i.e when money should be debited from customer
Example:-
1622369936
merchant_id
*
string
required
The format of the response. Should be passed as json.
200 : Success
Response Body
order_id
string
Given order ID
status
string
Status of order
txn_id
string
Transaction ID for the payment attempt. Can be used as an identifier at PG end and will be present in reconciliation report.
txn_uuid
string
The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction
payment.authentication.url
string
URL to which the user has to be taken to for completing the authentication
payment.authentication.method
string
HTTP Method for authentication. Can be one of GET or POST
offer_details
JSON
Json with offer details
offer_details.offers
Array
Contains array of offers applicable
400 : Invalid Input data
Response Body
status
string
DUPLICATE_ORDER_ID
status_id
integer
DUPLICATE_ORDER_ID
error_message
string
Order already exists with the given order_id
401 : Authentication Failed
Response Body
status
string
error
error_code
string
access_denied
500 : Unexpected Error
Response Body
status
string
error
error_code
string
Internal server Error