Get Offer Order Status

Response Parameters

Field

Description

customer_email

The email Id of the customer passed during order creation

customer_phone

The phone number of the customer passed during order creation

customer_id

The customer id passed during order creation

status_id

Status ID is a numeric id corresponding to the status value. Refer here

status

Status of the order. Refer here

id

Unique ID generated by JusPay for the given order

merchant_id

The merchant id/ username provided by Juspay

amount

The order amount

currency

The currency passed during order creation. Default is INR

order_id

Given order ID.

date_created

Order creation timestamp in UTC

return_url

The return url provided during order creation

product_id

The product_id provided during order creation. Empty in case its not passed

payment_links

Link to checkout page that is optimized for Desktop, mobile and iframe for the given order.

udf1-udf10

The user defined fields passed during order creation. Empty in case not passed

txn_id

Transaction ID for the payment attempt. Can be used as an identifier at PG end and will be present in reconciliation report.

payment_method_type

The payment method type used for transaction. Possible values are CARD, NB, WALLET, UPI, CONSUMER_FINANCE

payment_method

The payment method used for the transaction

auth_type

Possible values THREE_DS, OTP, VIES

refunded

true if the order has been completely refunded. Will be false for partial refunds or if the order doesn’t have any refunds.

amount_refunded

Amount which has been refunded so far for the given order

refunds

The refund block with the details of refund initiated for the given order.

offers

The offers block gives you the details for offers applied in the transaction(Array of offers)

txn_uuid

The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction

txn_detail

The json object with the details of the transaction

payment_gateway_response

The json object with the details receive from PG

payment_gateway_response .resp_code

The response code provided by the gateway

payment_gateway_response .rrn

The bank reference number provided by the gateway

payment_gateway_response .created

The transaction creation timestamp

payment_gateway_response .epg_txn_id

The gateway transaction id

payment_gateway_response .auth_id_code

Auth code provided by the gateway for the transaction.

payment_gateway_response .txn_id

Transaction ID for the payment attempt.

payment_gateway_response .resp_message

The response message provided by the gateway

payment_gateway_response .offer_type

The type of offer applied provided by the gateway( available only if offers are applied)

payment_gateway_response .offer_availed

true if the offer is applied at the payment gateway. Else it will be false ( available only if offers are applied)

payment_gateway_response .discount_amount

The discount amount provided by the gateway for the availed offer ( available only if offers are applied)

gateway_id

Gateway Id of the gateway used for performing this transactions.

gateway_reference_id

The gateway reference id used for the transaction

card

The json containing the details of the card used for the transaction

card.expiry_year

The expiry year of the card used for the transaction

card.card_reference

A reference identifier for the card.

card.expiry_month

The expiry month of the card used for the transaction

card.saved_to_locker

true if card was saved to locker, else false

card.name_on_card

The name on card used for the transaction

card.card_issuer

Indicates the bank which issued the card.

card.last_four_digits

The last four digit of the card used

card.using_saved_card

true for saved card transaction. false for new card transaction

card.card_fingerprint

The unique identifier for the card

card.card_isin

The first six digit of the card used for the transaction

card.card_type

Indicates if the card is either CREDIT or DEBIT

card.card_brand

The provider of the card, can be VISA, RUPAY etc.

Offers Block Details

Field

Description

offers.offer_id

Offer ID - The UUID which is a unique identifier for the offer from Juspay end

offers.offer_code

The code that is configured by on the offer operations dashboard

offers.status

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

offers.benefits

JSON explaining the offer rules for the gratification that was applied (Array of benefits)

offers.benefits.amount

The gratification the user has derived by applying this offer

offers.benefits.type

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

offers.benefits.calculation_info

JSON exploring the calculation rules of the offer benefits
All these rules are configured on the dashboard

offers.benefits.calculation_info.value

The percentage number or the absolute benefit number which was configured on the dashboard

offers.benefits.calculation_info.calculation_rule

Either PERCENTAGE or ABSOLUTE

offers.benefits.calculation_info.max_amount

The 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!