Order Status API
This is a Server-to-Server API that takes orderid as a path variable and returns the status of the order along with other details.
We recommend verifying the details like amount, offer details (if any) in the response of order status with the details in your system. If there is any mismatch do not full-fill the order.
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Merchant ID provided by Juspay
Example:-
merchant-id
Pass the date in YYYY-MM-DD format
Example:-
2023-01-01
application/x-www-form-urlencoded
Unique ID generated by JusPay for the given order
Given order ID
Status of order
Status ID is a numeric id corresponding to the status value
The order amount
Order creation timestamp in UTC
The email Id of the customer passed during order creation
The phone number of the customer passed during order creation
The customer id passed during order creation
The merchant id provided by Juspay
The currency passed during order creation. Default is INR
The return url provided during order creation
The product_id provided during order creation. Empty in case its not passed
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 CARD, NB, WALLET, UPI, CONSUMER_FINANCE
The payment method used for the transaction
Possible values THREE_DS, OTP, VIES
true if the order has been completely refunded. Will be 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 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
Unique ID generated by JusPay for the given order
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 for saved card transaction. false for new card transaction
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.
invalid_request_error
bad_authentication
Bad Authentication Data
NOT_FOUND
40
[order_id]
Have questions?
- Need help? Contact support
- LLM? Read llms.txt