Body
Merchant exercises the Mandate (Recurring payments)
After the Mandate is successful, Merchant will receive a mandate_id from Juspay that should be stored against a customer at their end. From the subsequent charge transactions, Merchant is supposed to pass a combination of customer_id and mandate_id to do a charge without a 2nd factor. This API will create order and will charge it based on the mandate_id passed by the merchant.
In case of Credit Cards, the charge is real time, so status can be CHARGED or AUTHORISATION_FAILED. In the case of e-mandate (netbanking / aadhaar), this might be PENDING_VBV, for which Merchant should poll after the appropriate time.
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
order.order
*
string
Required
Unique Identifier for the order.
order. amount
*
string
Required
This is the amount that a customer will be charge in this transaction.
order.currency
string
ISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. Default value: INR
order.customer_id
*
string
Required
Customer Identifier against which a mandate was created.
order.customer_email
string
Email address of the customer. If the backend gateway requires it, then you must send this value.
order.customer_phone
string
Mobile number or fixed line number of the customer. If the backend gateway requires it, then you must
order.description
string
Short description for the order. We send this information to the backend gateways whenever there is a provision for this.
order.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.
order.product_id
string
An identifier for the product. Fits well for impulse purchase usecases
order.billing_address_first_name
string
First name in the billing address
order.billing_address_last_name
string
Last name in the billing address
order.billing_address_line1
string
Line1 in the billing address
order.billing_address_line2
string
Line2 in the billing address
order.billing_address_line3
string
Line3 in the billing address
order.billing_address_city
string
Billing address city
order.billing_address_state
string
Billing address state
order.billing_address_country
string
Billing address country
order.billing_address_postal_code
string
Billing address postal code or zip code
order.billing_address_phone
string
Mobile or phone number in the billing address
order.billing_address_country_code_iso
string
ISO Country code. Default value: IND
order.shipping_address_first_name
string
First name in the shipping address
order.shipping_address_last_name
string
Last name in the shipping address
order.shipping_address_line1
string
Line1 in the shipping address
order.shipping_address_line2
string
Line2 in the shipping address
order.shipping_address_line3
string
Line3 in the shipping address
order.shipping_address_city
string
Shipping address city
order.shipping_address_state
string
Shipping address state
order.shipping_address_country
string
Shipping address country
order.shipping_address_postal_code
string
Shipping address postal code or zip code
order.shipping_address_phone
string
Mobile or phone number in the shipping address
order.shipping_address_country_code_iso
string
ISO Country code. Default value: IND
order.udf1
string
order.udf2
string
order.udf3
string
order.udf4
string
order.udf5
string
order.udf6
string
order.udf7
string
order.udf8
string
order.udf9
string
order.udf10
string
order.metadata
string
mandate_id
*
string
Required
Mandate id sent by Juspay after mandate creation
200 : Success
Response Body
txn_uuid
string
eul81DBJR2Yv6gjZ7ue
txn_id
string
Transaction Id for the payment
status
string
Status of the transaction. See appendix.
payment
object
authentication.method
String
HTTP Method for authentication. Can be one of GET or POST
authentication.url
String
URL to which the user has to be taken to for completing the authentication
order_id
string
OrderID for which the payment is being started.