Get Offer Order Status
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
application/x-www-form-urlencoded
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.
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
Order Id
Example:- JP1636474794
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
Status ID is a numeric id corresponding to the status value.
Status of the order.
Unique ID generated by JusPay for the given order
The merchant id/ username provided by Juspay
The order amount
The currency passed during order creation. Default is INR
Given order ID.
Order creation timestamp in UTC
The return url provided during order creation
The product_id provided during order creation. Empty in case its not passed
Link to checkout page that is optimized for Desktop, mobile and iframe for the given order.
https://api.juspay.in/merchant/ipay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77
https://api.juspay.in/merchant/pay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77
https://api.juspay.in/merchant/pay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77?mobile=true
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case not passed
The user defined fields passed during order creation. Empty in case 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
Possible values THREE_DS, OTP, VIES
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.
true if card was saved to locker, else false
The expiry month of the card used for the transaction
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.
The payment method used for the transaction
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 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
merchant_success-JP1636474794-1
JP1636474794
CHARGED
INR
eulwh5QbZSBvw35eWnH
RAZORPAY
2021-11-09T16:20:52Z
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
The gateway transaction id
The response message provided by the gateway
Auth code provided by the gateway for the transaction.
Transaction ID for the payment attempt.
Gateway Id of the gateway used for performing this transactions.
The gateway reference id used for the transaction
The gateway reference id used for the transaction
The offers block gives you the details for offers applied in the transaction(Array of offers)
Offer ID - The UUID which is a unique identifier for the offer from Juspay end
The code that is configured by on the offer operations dashboard
The status of the offer:
INITIATED - Offer is redeemed, awaiting transaction status for final redemption
AVAILED - Offer was redeemed
REFUNDED - Offer was reverted, due to transaction being refunded
FAILED - Offer was not redeemed since the offer validations have failed
JSON explaining the offer rules for the gratification that was applied (Array of benefits)
All these rules are configured on the dashboard
Type of gratification:
1. Cashback
2. Discount
3. Merchant Discount(Payment locking) - No gratification applied by Juspay
JSON exploring the calculation rules of the offer benefits
All these rules are configured on the dashboard
The percentage number or the absolute benefit number which was configured on the dashboard
Either PERCENTAGE or ABSOLUTE
The maximum value the benefit is when the calculation rule is PERCENTAGE
The gratification the user has derived by applying this offer
The refund block with the details of refund initiated for the given order.
Have questions?
- Need help? Contact support
- LLM? Read llms.txt