Body
Create Order API
Create an order that is a representation of your shopping cart. The order contains important information like amount, customer details, shipping address, billing address, etc. Only after an order is created, payment can be started.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/orders
Production Link
POST
https://api.juspay.in/orders
Authorization Header
Basic Auth
*
Base64 Encoded Username-Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
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
Basic Parameters
order_id
*
String
Mandatory
Unique Identifier for the order. Should be Alphanumeric with character length less than 18.
amount
*
Double
Mandatory
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.
offers_applied
String
In order to avoid the discount being offered twice in the user payment journey, this field has been introduced.
At the time of Order Creation at Juspay server merchant should pass field offers_applied = true/false based on whether the user has applied an offer on the merchant payment page or not.
200 : Success
Response Body
status
String
Status of order
status_id
Integer
Status ID is a numeric id corresponding to the status value.
id
String
Unique ID generated by Juspay for the given order
order_id
String
Order Id passed during order creation
payment_links
JSON
Https link using which user can open payment page and perform transaction against the order created
web
String
mobile
String
iframe
String
400 : Invalid Input data
Response Body
status
String
Bad Request
error_code
String
Details of keys missing
Example:-
Mandatory fields are missing
error_message
String
Further Details of keys missing