Get Offer Order Status

Response Parameters

FieldDescription
customer_emailThe email Id of the customer passed during order creation
customer_phoneThe phone number of the customer passed during order creation
customer_idThe customer id passed during order creation
status_idStatus ID is a numeric id corresponding to the status value. Refer here
statusStatus of the order. Refer here
idUnique ID generated by JusPay for the given order
merchant_idThe merchant id/ username provided by Juspay
amountThe order amount
currencyThe currency passed during order creation. Default is INR
order_idGiven order ID.
date_createdOrder creation timestamp in UTC
return_urlThe return url provided during order creation
product_idThe product_id provided during order creation. Empty in case its not passed
payment_linksLink to checkout page that is optimized for Desktop, mobile and iframe for the given order.
udf1-udf10The user defined fields passed during order creation. Empty in case not passed
txn_idTransaction ID for the payment attempt. Can be used as an identifier at PG end and will be present in reconciliation report.
payment_method_typeThe payment method type used for transaction. Possible values are CARD, NB, WALLET, UPI, CONSUMER_FINANCE
payment_methodThe payment method used for the transaction
auth_typePossible values THREE_DS, OTP, VIES
refundedtrue if the order has been completely refunded. Will be false for partial refunds or if the order doesn’t have any refunds.
amount_refundedAmount which has been refunded so far for the given order
refundsThe refund block with the details of refund initiated for the given order.
offersThe offers block gives you the details for offers applied in the transaction(Array of offers)
txn_uuidThe unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction
txn_detailThe json object with the details of the transaction
payment_gateway_responseThe json object with the details receive from PG
payment_gateway_response .resp_codeThe response code provided by the gateway
payment_gateway_response .rrnThe bank reference number provided by the gateway
payment_gateway_response .createdThe transaction creation timestamp
payment_gateway_response .epg_txn_idThe gateway transaction id
payment_gateway_response .auth_id_codeAuth code provided by the gateway for the transaction.
payment_gateway_response .txn_idTransaction ID for the payment attempt.
payment_gateway_response .resp_messageThe response message provided by the gateway
payment_gateway_response .offer_typeThe type of offer applied provided by the gateway( available only if offers are applied)
payment_gateway_response .offer_availedtrue if the offer is applied at the payment gateway. Else it will be false ( available only if offers are applied)
payment_gateway_response .discount_amountThe discount amount provided by the gateway for the availed offer ( available only if offers are applied)
gateway_idGateway Id of the gateway used for performing this transactions.
gateway_reference_idThe gateway reference id used for the transaction
cardThe json containing the details of the card used for the transaction
card.expiry_yearThe expiry year of the card used for the transaction
card.card_referenceA reference identifier for the card.
card.expiry_monthThe expiry month of the card used for the transaction
card.saved_to_lockertrue if card was saved to locker, else false
card.name_on_cardThe name on card used for the transaction
card.card_issuerIndicates the bank which issued the card.
card.last_four_digitsThe last four digit of the card used
card.using_saved_cardtrue for saved card transaction. false for new card transaction
card.card_fingerprintThe unique identifier for the card
card.card_isinThe first six digit of the card used for the transaction
card.card_typeIndicates if the card is either CREDIT or DEBIT
card.card_brandThe provider of the card, can be VISA, RUPAY etc.

Offers Block

FieldDescription
offers.offer_idOffer ID - The UUID which is a unique identifier for the offer from Juspay end
offers.offer_codeThe code that is configured by on the offer operations dashboard
offers.statusThe 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
offers.benefitsJSON explaining the offer rules for the gratification that was applied (Array of benefits)
offers.benefits.amountThe gratification the user has derived by applying this offer
offers.benefits.typeAll these rules are configured on the dashboard
Type of gratification:
1. Cashback
2. Discount
3. Merchant Discount(Payment locking) - No gratification applied by Juspay
offers.benefits.calculation_infoJSON exploring the calculation rules of the offer benefits
All these rules are configured on the dashboard
offers.benefits.calculation_info.valueThe percentage number or the absolute benefit number which was configured on the dashboard
offers.benefits.calculation_info.calculation_ruleEither PERCENTAGE or ABSOLUTE
offers.benefits.calculation_info.max_amountThe maximum value the benefit is when the calculation rule is PERCENTAGE
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!