--- page_title: Order Status API product: Payv3 platform: Web page_source: https://juspay.io/in/docs/payv3/web/base-integration/order-status-api openapi: https://juspay.io/in/docs/api/swagger?document=https%3A%2F%2Fjuspay.io%2Fin%2Fdocs%2Fpayv3%2Fweb%2Fbase-integration%2Forder-status-api llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/payv3/llms.txt --- ## API Version: default # Order Status API To Fetch the amount breakup for cred payment, please add `options.add_full_gateway_response=true` when calling Juspay order status api. Version needs to be passed in the header, value: 2018-10-25## Endpoints: - Sandbox: https://sandbox.juspay.in/orders/ - Production: https://api.juspay.in/orders/ ## Request Type: GET ## Content-Type: application/json ## Authorization: #### Basic Auth: Consists of two parts. * Username: API Key obtained from Juspay dashboard * Password: Empty string Example:-MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg== - Value: MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: Base64 Encoded Username:Password, Required ## Headers: #### version: Pass the date in YYYY-MM-DD format - Tags: String, Required ## Sample Code Snippets: ### Sample Request: #### Request Code Snippet: ```request https://api.juspay.in/orders/?options.add_full_gateway_response=true \ --header 'x-routing-id: customer_1122'\ --header 'version: 2023-06-30' ``` ### Sample Response: #### Response: ```json { "udf9": "", "udf8": "", "udf7": "", "udf6": "", "udf5": "", "udf4": "", "udf3": "", "udf2": "", "udf10": "", "udf1": "", "txn_uuid": "eulxdBmoZiHpFUSroaZ", "txn_id": "Symbol-R3558939064-1", "status_id": 21, "status": "CHARGED", "return_url": "https://api.juspay.in/end", "refunded": false, "product_id": "", "payment_method_type": "WALLET", "payment_method": "CRED", "payment_links": { "web": "https://api.juspay.in/merchant/pay/ordeh_89616c88f79141578fa87c28c7f3e606", "mobile": "https://api.juspay.in/merchant/pay/ordeh_89616c88f79141578fa87c28c7f3e606?mobile=true", "iframe": "https://api.juspay.in/merchant/ipay/ordeh_89616c88f79141578fa87c28c7f3e606" }, "payment_gateway_response": { "txn_id": "Symbol-R3558939064-1", "rrn": null, "resp_message": null, "resp_code": null, "gateway_response": { "status": "OK", "error_code": null, "response": { "amount": { "value": 2, "currency": "INR" }, "state": "COMPLETED", "refunds": null, "payment_modes": [ { "amount": { "value": 1, "currency": "INR" }, "funding_source": null, "gateway_reference_id": null }, { "amount": { "value": 1, "currency": "OFFER" }, "funding_source": { "others": 0.1, "merchant": 0.9 }, "gateway_reference_id": null } ], "tracking_id": "Symbol-R3558939064-1", "user": { "country_code": null, "phone_number": null, "user_id": "09YUxxxxxQRuAGaLE396vrxJ3SSmHnz2Ru1BBCxxxxxxxxJKqkxBc1b1vAmdT2Z0iFW/Vq2k348/eC1TKCzxxxxxxxx41xf4uCBv9ZKCAzE=" }, "reference_id": "a80xxxx1-c111-4a05-a446-890xxxxx83bc" }, "error_description": null, "error_message": null }, "epg_txn_id": null, "created": "2021-02-01T09:03:58Z", "auth_id_code": null }, "order_id": "R3558939064", "merchant_id": "Symbol", "id": "ordeh_89616c88f79141578fa87c28c7f3e606", "gateway_id": 777, "date_created": "2021-02-01T09:02:30Z", "customer_phone": "7338513542", "customer_id": "test_customer", "customer_email": "test007@gmail.com", "currency": "INR", "bank_error_message": "", "bank_error_code": "", "auth_type": "", "amount_refunded": 0, "amount": 2 } ``` ## API Responses: ### 200: #### id: - Description: Unique ID generated by JusPay for the given order - Tags: String #### order_id: - Description: The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction - Tags: String #### status: - Description: Status of order - Tags: String #### status_id: - Description: Status ID is a numeric id corresponding to the status value - Tags: String #### amount: - Description: The order amount - Tags: Double #### date_created: - Description: Order creation timestamp in UTC - Tags: String #### 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 #### merchant_id: - Description: The merchant id provided by Juspay - Tags: String #### currency: - Description: The currency passed during order creation. Default is INR - 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 #### udf1-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: Wallet - Tags: String #### payment_method: - Description: CRED - Tags: String #### auth_type: - 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: String #### refunds: - Description: The refund block with the details of refund initiated for the given order. - Tags: String #### txn_detail: - Description: The json object with the details of the transaction - Tags: JSON #### payment_gateway_response: - Description: The json object with the details receive from PG - Value: - **Payment_gateway_response.resp_code**: - Description: Unique ID generated by JusPay for the given order - 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: Transaction Id from the underlying 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 - **Resp_message**: - Description: The response message provided by the gateway - Tags: String - **Response**: - Tags: Object - Tags: String #### gateway_id: - Description: Gateway Id of the gateway used for performing this transactions - Tags: String --- ## See Also - [Order Create API](https://juspay.io/in/docs/payv3/web/base-integration/order-create) - [Payment Methods](https://juspay.io/in/docs/payv3/web/base-integration/payment-methods)