Order Status API
This is a Server-to-Server API that takes orderid as a path parameter and returns the status of the order along with other details.
Validate the order amount and status using the Order Status API before proceeding with order fulfillment. Neglecting this step could lead to mismatched orders, incorrect or fraudulent transactions.
If multiple transactions are performed for the same order, the final order status is determined by the highest precedence among the transaction statuses.Precedence (in ascending order): NEW → PENDING_VBV → CHARGED
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
Merchant ID provided by Juspay or Juspay's merchant id.
Pass the date in YYYY-MM-DD format.
Note: If a version is provided, the response will include data corresponding to that specific version date.
It is recommended not to enforce strict validation on the entire response on the merchant's side to allow for future key additions.
Example:- Sample Value: 2025-01-10
application/x-www-form-urlencoded
Order Id of the order for which you want to check the status
Example:- JP1636474794
It accepts a Boolean value.
- Set it to true to receive the complete response from the gateway.
Unique ID generated by JusPay for the given order
OrderId provided in the request
Status of the order. For information on different order status and handling, refer here
Status ID is a numeric id corresponding to the status value
The order amount
Order creation timestamp in UTC
Example: 2021-11-09T16:19:55Z
The email Id of the customer provided during order creation
The phone number of the customer provided during order creation
The customer id provided during order creation
The merchant id provided by Juspay
The currency provided during order creation.
Default: INR
The return url provided during order creation
The product_id provided during order creation
The user defined fields passed during order creation. Empty in case not passed
Transaction ID for the payment attempt. Can be used as an identifier at PG end and will be present in reconciliation report.
The payment method type used for transaction.
Possible values are as follows:
Example:- CARDCARD, NB, WALLET, UPI, CONSUMER_FINANCE, CASH
The payment method used for the transaction.
You may refer to this doc for possible values for payment_method.
Possible values THREE_DS, OTP, VIES
true if the order has been completely refunded
false for partial refunds or if the order doesn't have any refunds
Amount which has been refunded so far for the given order
The refund block with the details of refund initiated for the given order.
The unique request id provided during refund initiation
The status of the refund initiated. Initial status will always be PENDING
The flag denotes if the refund was initiated to gateway. The initial status is always false, as refunds are queued at juspay for a period of 15 minutes
The type of refund. Values can be STANDARD, INSTANT
The name of gateway from which amount is refunded
The refund id provided by the PG
The source of initiation
The reference id provided by PG, if not available then its mapped to unique request id.
The refund amount passed in the request
The timestamp of refund creation
The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction
The json object with the details of the transaction
The json object with the details receive from PG
The response code provided by the gateway
The bank reference number provided by the gateway
The transaction creation timestamp
Transaction Id from the underlying gateway
Auth code provided by the gateway for the transaction.
Transaction Id for the payment attempt
The response message provided by the gateway
The type of offer applied provided by the gateway( available only if offers are applied)
true if the offer is applied at the payment gateway. Else it will be false ( available only if offers are applied)
The discount amount provided by the gateway for the availed offer ( available only if offers are applied)
Gateway Id of the gateway used for performing this transactions
The gateway reference id used for the transaction
The json containing the details of the card used for the transaction
The expiry year of the card used for the transaction
A reference identifier for the card.
The expiry month of the card used for the transaction
true if card was saved to locker, else false
The name on card used for the transaction
Indicates the bank which issued the card
The last four digit of the card used
true if transaction was done via a saved card
false if transaction via new card/unsaved card
The unique identifier for the card
The first six digit of the card used for the transaction
Indicates if the card is either CREDIT or DEBIT
The provider of the card, can be VISA, RUPAY etc.
Bad Request
Details of keys missing
Example:-
Mandatory fields are missing
Further Details of keys missing
error
access_denied
error
Internal server Error
Error Codes
|
Scenario
|
Error Code
|
Description
|
Sample Response
|
|---|---|---|---|
Not passing the version in header
| -
| Note: If a version is provided, the response will include data corresponding to that specific version date. It is recommended not to enforce strict validation on the entire response on the merchant's side to allow for future key additions.
| Response with 200
|
Invalid order id
| 400
| Bad Request
| {"status":"NOT_FOUND","error_info":{"user_message":"Order Not Found","developer_message":"Order Not Found","code":"RESOURCE_NOT_FOUND","category":"USER_ERROR"},"status_id":40,"order_id":"173824171"}
|
Invalid API Key
| 401
| Unauthorized
| {"status":"error","error_code":"access_denied","error_info":{"user_message":"Unauthorized.","developer_message":"Invalid API Key. Please pass a valid and active api key.","code":"UNAUTHORIZED","category":"USER_ERROR"}}
|
Passing an invalid URL
| 404
| Not Found
|