--- page_source: https://docs.juspay.io/paytm-gateway-configuration/docs/express-checkout/get-offer-order-status page_title: Get Offer Order Status --- ## API Version: default # Get Offer Order Status ## Endpoints: - Production: https://api.juspay.in/orders/{order_id} ## Request Type: GET ## Authorization: #### Basic Auth: Consists of two parts. * Username: API Key obtained from Juspay dashboard * Password: Empty string Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: Base64 Encoded Username:Password, Mandatory ## Headers: #### version: Pass the current date in YYYY-MM-DD format - Tags: String #### Content-Type: application/x-www-form-urlencoded - Tags: String ## Sample Code Snippets: ### Sample Request: #### Request Code Snippet: ```request curl --location --request GET 'https://api.juspay.in/orders/JP1636474794' \ --header 'version: 2023-06-30' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic OTc5Mzcx*****czRTlGOg==' ``` ### Sample Response: #### Response: ```json { "customer_email": "test@gmail.com", "customer_phone": "99999999", "customer_id": "testcardenc1", "status_id": 21, "status": "CHARGED", "id": "ordeh_57dfd768bb7d4896bc042y0b90bc9ad77", "merchant_id": "merchant_success", "amount": 1, "currency": "SGD", "order_id": "JP1636474794", "date_created": "2021-11-09T16:19:55Z", "return_url": "", "product_id": "", "payment_links": { "iframe": "https://api.juspay.in/merchant/ipay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77", "web": "https://api.juspay.in/merchant/pay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77", "mobile": "https://api.juspay.in/merchant/pay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77?mobile=true" }, "udf1": "", "udf2": "", "udf3": "", "udf4": "", "udf5": "", "udf6": "", "udf7": "", "udf8": "", "udf9": "", "udf10": "", "txn_id": "merchant_success-JP1636474794-1", "payment_method_type": "CARD", "auth_type": "THREE_DS", "card": { "expiry_year": "2024", "card_reference": "17a2ec4f27c918bd8dbc58c9ae74090e", "saved_to_locker": false, "expiry_month": "12", "name_on_card": "test", "card_issuer": "JP Morgan", "last_four_digits": "", "using_saved_card": true, "card_fingerprint": "32qqi3sv1u5237fq7ura2rgqqb", "card_isin": "411111", "card_type": "CREDIT", "card_brand": "VISA", "using_token": false }, "offers": [ { "offer_id": "ed2743f5-6c22-4890-87a0-c56f4ba2fd92", "offer_code": "BOID", "status": "AVAILED", "benefits": [ { "type": "DISCOUNT", "calculation_info": { "value": 10, "calculation_rule": "PERCENTAGE", "max_amount": 100 }, "amount": 100 } ] } ], "payment_method": "VISA", "refunded": true, "amount_refunded": 1, "effective_amount": 1, "refunds": [ { "id": "TEST1637681731", "amount": 1, "unique_request_id": "TEST1637681731", "ref": "rfnd_IP693G3wAX4ibJ", "created": "2021-11-23T15:35:32Z", "status": "SUCCESS", "error_message": "processed", "sent_to_gateway": true, "initiated_by": "API", "refund_source": "STRIPE", "refund_type": "STANDARD", "metadata": { "speed_processed": "normal", "speed_requested": "normal" }, "error_code": "processed" } ], "resp_code": null, "resp_message": null, "bank_error_code": "", "bank_error_message": "", "txn_uuid": "eulwh5QbZSBvw35eWnH", "txn_detail": { "txn_id": "merchant_success-JP1636474794-1", "order_id": "JP1636474794", "status": "CHARGED", "error_code": null, "net_amount": 1, "surcharge_amount": null, "tax_amount": null, "txn_amount": 1, "offer_deduction_amount": null, "gateway_id": 23, "currency": "SGD", "express_checkout": true, "redirect": true, "txn_uuid": "eulwh5QbZSBvw35eWnH", "gateway": "STRIPE", "error_message": "", "created": "2021-11-09T16:20:52Z" }, "payment_gateway_response": { "resp_code": "SUCCESS", "rrn": "156555", "created": "2021-11-09T16:21:11Z", "epg_txn_id": "pay_IJZKtTpki24ERy", "resp_message": "SUCCESS", "auth_id_code": "156555", "txn_id": "merchant_success-JP1636474794-1" }, "gateway_id": 23, "metadata": { "STRIPE:gateway_reference_id": "testmid" }, "gateway_reference_id": "testmid" } ``` ## API Responses: ### 200: #### customer_email: - Description: The email Id of the customer passed during order creation - Tags: string #### customer_phone: - Description: The phone number of the customer passed during order creation - Tags: string #### customer_id: - Description: The customer id passed during order creation - Tags: string #### status_id: - Description: Status ID is a numeric id corresponding to the status value. - Tags: integer #### status: - Description: Status of the order. - Tags: string #### id: - Description: Unique ID generated by JusPay for the given order - Tags: string #### merchant_id: - Description: The merchant id/ username provided by Juspay - Tags: string #### amount: - Description: The order amount - Tags: integer #### currency: - Description: The currency passed during order creation. Default is INR - Tags: string #### order_id: - Description: Given order ID. - Tags: string #### date_created: - Description: Order creation timestamp in UTC - Tags: string #### return_url: - Description: The return url provided during order creation - Tags: string #### product_id: - Description: The product_id provided during order creation. Empty in case its not passed - Tags: string #### payment_links: - Description: Link to checkout page that is optimized for Desktop, mobile and iframe for the given order. - Value: - **Iframe**: - Description: https://api.juspay.in/merchant/ipay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77 - Tags: string - **Web**: - Description: https://api.juspay.in/merchant/pay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77 - Tags: string - **Mobile**: - Description: https://api.juspay.in/merchant/pay/ordeh_57dfd768bb7d4896bc042y0b90bc9ad77?mobile=true - Tags: string - Tags: object #### udf1: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf2: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf3: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf4: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf5: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf6: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf7: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf8: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf9: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### udf10: - Description: The user defined fields passed during order creation. Empty in case not passed - Tags: string #### txn_id: - Description: Transaction ID for the payment attempt. Can be used as an identifier at PG end and will be present in reconciliation report. - Tags: string #### payment_method_type: - Description: The payment method type used for transaction. Possible values are CARD, NB, WALLET, UPI, CONSUMER_FINANCE - Tags: string #### auth_type: - Description: Possible values THREE_DS, OTP, VIES - Tags: string #### card: - Description: The json containing the details of the card used for the transaction - Value: - **Expiry_year**: - Description: The expiry year of the card used for the transaction - Tags: string - **Card_reference**: - Description: A reference identifier for the card. - Tags: string - **Saved_to_locker**: - Description: **true** if card was saved to locker, else **false** - Tags: boolean - **Expiry_month**: - Description: The expiry month of the card used for the transaction - Tags: string - **Name_on_card**: - Description: The name on card used for the transaction - Tags: string - **Card_issuer**: - Description: Indicates the bank which issued the card. - Tags: string - **Last_four_digits**: - Description: The last four digit of the card used - Tags: string - **Using_saved_card**: - Description: **true** for saved card transaction. **false** for new card transaction - Tags: boolean - **Card_fingerprint**: - Description: The unique identifier for the card - Tags: string - **Card_isin**: - Description: The first six digit of the card used for the transaction - Tags: string - **Card_type**: - Description: Indicates if the card is either CREDIT or DEBIT - Tags: string - **Card_brand**: - Description: The provider of the card, can be VISA, RUPAY etc. - Tags: string - **Using_token**: - Tags: boolean - Tags: object #### payment_method: - Description: The payment method used for the transaction - Tags: string #### refunded: - Description: **true** if the order has been completely refunded. Will be **false** for partial refunds or if the order doesn’t have any refunds. - Tags: boolean #### amount_refunded: - Description: Amount which has been refunded so far for the given order - Tags: integer #### effective_amount: - Tags: integer #### resp_code: - Tags: String #### resp_message: - Tags: String #### bank_error_code: - Tags: string #### bank_error_message: - Tags: string #### txn_uuid: - Description: The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction - Tags: string #### txn_detail: - Description: The json object with the details of the transaction - Value: - **Txn_id**: - Description: merchant_success-JP1636474794-1 - Tags: string - **Order_id**: - Description: JP1636474794 - Tags: string - **Status**: - Description: CHARGED - Tags: string - **Error_code**: - **Net_amount**: - Tags: integer - **Surcharge_amount**: - **Tax_amount**: - **Txn_amount**: - Tags: integer - **Offer_deduction_amount**: - **Gateway_id**: - Tags: integer - **Currency**: - Description: INR - Tags: string - **Express_checkout**: - Tags: boolean - **Redirect**: - Tags: boolean - **Txn_uuid**: - Description: eulwh5QbZSBvw35eWnH - Tags: string - **Gateway**: - Description: RAZORPAY - Tags: string - **Error_message**: - Tags: string - **Created**: - Description: 2021-11-09T16:20:52Z - Tags: string - Tags: object #### payment_gateway_response: - Description: The json object with the details receive from PG - Value: - **Resp_code**: - Description: The response code provided by the gateway - Tags: string - **Rrn**: - Description: The bank reference number provided by the gateway - Tags: string - **Created**: - Description: The transaction creation timestamp - Tags: string - **Epg_txn_id**: - Description: The gateway transaction id - Tags: string - **Resp_message**: - Description: The response message provided by the gateway - Tags: string - **Auth_id_code**: - Description: Auth code provided by the gateway for the transaction. - Tags: string - **Txn_id**: - Description: Transaction ID for the payment attempt. - Tags: string - Tags: object #### gateway_id: - Description: Gateway Id of the gateway used for performing this transactions. - Tags: integer #### metadata: - Value: - **RAZORPAY:gateway_reference_id**: - Description: The gateway reference id used for the transaction - Tags: string - Tags: object #### gateway_reference_id: - Description: The gateway reference id used for the transaction - Tags: string #### Offers: - Description: The offers block gives you the details for offers applied in the transaction(Array of offers) - Value: - **Offer_id**: - Description: Offer ID - The UUID which is a unique identifier for the offer from Juspay end - Tags: String - **Offer_code**: - Description: The code that is configured by on the offer operations dashboard - Tags: String - **Status**: - Description: The status of the offer:INITIATED - Offer is redeemed, awaiting transaction status for final redemptionAVAILED - Offer was redeemedREFUNDED - Offer was reverted, due to transaction being refundedFAILED - Offer was not redeemed since the offer validations have failed - Tags: String - **Benefits**: - Description: JSON explaining the offer rules for the gratification that was applied (Array of benefits) - Value: - **Type**: - Description: All these rules are configured on the dashboardType of gratification:1. Cashback2. Discount3. Merchant Discount(Payment locking) - No gratification applied by Juspay - Tags: String - **Calculation_info**: - Description: JSON exploring the calculation rules of the offer benefitsAll these rules are configured on the dashboard - Value: - **Value**: - Description: The percentage number or the absolute benefit number which was configured on the dashboard - Tags: integer - **Calculation_rule**: - Description: Either PERCENTAGE or ABSOLUTE - Tags: String - **Max_amount**: - Description: The maximum value the benefit is when the calculation rule is PERCENTAGE - Tags: Integer - Tags: object - **Amount**: - Description: The gratification the user has derived by applying this offer - Tags: Integer - Tags: Array of objects - Tags: Array of objects #### refunds: - Description: The refund block with the details of refund initiated for the given order. - Value: - **Id**: - Tags: String - **Amount**: - Tags: Integer - **Unique_request_id**: - Tags: String - **Ref**: - Tags: String - **Created**: - Tags: String - **Status**: - Tags: String - **Error_message**: - Tags: String - **Sent_to_gateway**: - Tags: boolean - **Initiated_by**: - Tags: String - **Refund_source**: - Tags: String - **Refund_type**: - Tags: String - **Metadata**: - Value: - **Speed_processed**: - Tags: String - **Speed_requested**: - Tags: String - Tags: Object - **Error_code**: - Tags: String - Tags: Array of objects