Mandate Execution API

Response Parameters for the Mandate Execution API: (click to view)

Note:

This is the same as the Payment Status Object returned for Payments API requests.

In the redirect response, webhook, and check status API, mandate data will be passed additionally from the current parameters.

Parameter	Type	Description
order_id	String	Unique Identifier for the order.
txn_id	String	Transaction ID for the payment attempt.
txn_uuid	String	Transaction UUID
status	String	Status of the transaction. See Appendix below for status mapping. PENDING_VBV indicates that the transaction requires authentication to complete.
payment.authentication.method	String	HTTP Method for authentication. Can be one of GET or POST. (For redirection instructions, see the "Handling the Redirection Method" section above.)
payment.authentication.url	String	URL to which the user has to be taken to for completing the authentication
payment.authentication.params	String	Present only when the method is POST. Parameter map that has to be sent along with the URL for authentication.

APPENDIX - Transaction status codes and meaning:

Status	ID	Meaning
NEW	10	Newly created order
PENDING_VBV	23	Authentication is in progress
CHARGED	21	Successful transaction
AUTHENTICATION_FAILED	26	User did not complete authentication
JUSPAY_DECLINED	22	User input is not accepted by the underlying PG
AUTHORIZING	28	Transaction status is pending from bank

Request Parameters - The request consists of mandate_id and/or mandate_token, and an Order Object, which contains the following Parameter Groups:
(click to open tables)ww Each parameter in tables is listed below:

⭣

Note:

Check table here for additional request parameters that may be required depending on the payment gateway or aggregator used on the backend.
(click to view & move left to right)

Parameter	HDFC	ICICI	Axis	PayU	Citrus	PayTM	EBS	RazorPay	CCAvenue
order_id	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
amount	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
customer_id	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
customer_email	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes
customer_phone	Optional	Optional	Optional	Yes	Yes	Yes	Yes	Yes	Yes
description	Optional	Optional	Yes	Yes	Yes	Yes	Yes	Yes	Yes
product_id	No	No	No	No	No	No	No	No	No
billing_address_first_name	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_last_name	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_line1	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_line2	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_line3	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_city	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_state	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_country	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_postal_code	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_phone	No	No	No	Optional	Optional	No	Yes	No	Yes
billing_address_country_code_iso	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_first_name	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_last_name	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_line1	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_line2	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_line3	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_city	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_state	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_country	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_postal_code	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_phone	No	No	No	Optional	Optional	No	Yes	No	Yes
shipping_address_country_code_iso	No	No	No	Optional	Optional	No	Yes	No	Yes

Parameter Groups contained within Order Object:

Order Info Parameters:

Field		Type	Description
order_id	*	String	Unique Identifier for the order. You can pass your native order ID here. it is suggested to keep the order id length as a maximum of 21 characters.
amount	*	String	This is the amount that a customer will be charged in this transaction.
customer_id	*	String	Unique ID for a customer that you get after running the Create Customer API (Check Customer section for more details)
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 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.
metadata		String
gateway_id		String	Specify your preferred gateway for this order. Complete mapping for “gateway_id” can be found here: Gateway mapping

* = Required

Billing/Shipping Address Parameters:

Field	Type	Description
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	Line1 in the billing address
billing_address_line2	String	Line2 in the billing address
billing_address_line3	String	Line3 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


shipping_address_first_name	String	First name in the shipping address
shipping_address_last_name	String	Last name in the shipping address
shipping_address_line2	String	Line2 in the shipping address
shipping_address_line3	String	Line3 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_country_code_iso	String	ISO Country code (Default value: IND)

UDF Parameters:

udf1 to udf10 - Optional user defined fields which will be echoed back in the response from Juspay with a Max character limit of 255. These fields may be used to pass any additional information that is required to be stored at Juspay for any analysis or other operations. In some cases, these UDFs are passed to the downstream gateways as well.

Field	Type	Description
udf1	String	User Defined Field
udf2	String
udf3	String
udf4	String
udf5	String
udf6	String
udf7	String
udf8	String
udf9	String
udf10	String

Other Parameters sent by API, but not included in a Parameter Group:

Field		Type	Description
mandate_token	*	String	Mandate token sent by Juspay after mandate creation. NOTE: This is a unique identifier generated by Juspay. Either mandate_id or mandate_token is mandatory.
mandate_id	*	String	Mandate ID sent by Juspay after mandate creation. Either mandate_id or mandate_token is mandatory.

* = Only one of these two parameters is required