---
page_title: HyperCredit Order Status API
product: HyperCredit
platform: Web
page_source: https://juspay.io/in/docs/hyper-credit/web/base-sdk-integration/hypercredit-order-status-api
openapi: https://juspay.io/in/docs/api/swagger?document=https%3A%2F%2Fjuspay.io%2Fin%2Fdocs%2Fhyper-credit%2Fweb%2Fbase-sdk-integration%2Fhypercredit-order-status-api
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/hyper-credit/llms.txt
---

## API Version: default


# HyperCredit Order Status API



When a session is generated, an Order is created in Juspay’s system. This Order might be associated with multiple Loan Applications, each of which shall be linked to a specific lender. For each Loan Application, Juspay retrieves available EMI offers from various lenders. Users are able to select only one offer from a single lender. Upon selection of an offer, Juspay initiates a transaction. This transaction's status is continuously updated in real-time based on information received from the lender through Juspay, ensuring consistent tracking and processing. The HyperCredit Order Status API offers detailed sub-statuses that track user activity throughout the order fulfillment process.

This is a Server-to-Server API that returns the status of the order along with other details in encrypted format.

Please ensure that you validate the amount and status of the order before fulfilling the order at your end.

For information on different order status and handling, refer here [order status](https://docs.juspay.in/api-reference/docs/express-checkout/order-status-api/edit)

* > **Warning**
  > This API shouldn't be used to fulfill the orders. The fulfillment of orders should be on the basis of [order status](https://docs.juspay.in/api-reference/docs/express-checkout/order-status-api/edit) of hypercheckout.## Endpoints:
- Sandbox: https://integ-expresscheckout-api.juspay.in/credit/order/{order_id}' 

- Production: https://api.juspay.in/credit/order/{order_id}

## Request Type: 
GET

## Content-Type: 
application/json

## Authorization:

#### Basic Auth (copy):
Consists of two parts.

* Username: API Key will be share by the credit team
* Password: Empty string
- Value: <p>Example:- <br> MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg== </p> 
- Tags: Base64 Encoded username:password, required
## Headers:

#### x-merchantid:
Merchant ID provided by Juspay
- Value: <p>Example:- <br> merchant-id</p> 
- Tags: string, required

#### version:
Pass the date in YYYY-MM-DD format
- Tags: string, required

#### Content-Type:
application/x-www-form-urlencoded
- Tags: String, Required
## Sample Code Snippets:
### Sample Request:

#### Request Code Snippet:

```request
curl --location  '<BaseUrl>/order/<orderId>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <auth-key>\
--header 'X-Request-Id: 1234dgerfhb'
```

### Sample Response:

#### Response:
```json
{
    "udf4": "",
    "user_message": null,
    "payment_methods_eligibility": [
        {
            "error_message": null,
            "payment_method": "MONEY_VIEW_LSP",
            "is_eligible": true
        }
    ],
    "payout_links": null,
    "udf8": "",
    "error_message": null,
    "udf3": "",
    "udf6": "",
    "status": "SUCCESS",
    "id": "LSP010376133bfd4265b1b29daa67543gcg",
    "return_url": null,
    "expiry_at": null,
    "error_code": null,
    "currency": "INR",
    "error": null,
    "date_created": "2025-03-21T08:07:38.213209Z",
    "udf2": "",
    "payment_links": {
        "mobile": null,
        "web": null,
        "iframe": null
    },
    "customer_email": "test@gmail.com",
    "customer_phone": "9999999999",
    "order_status": "CHARGED",
    "udf5": "",
    "status_id": 3,
    "merchant_id": "testmx",
    "udf9": "",
    "amount": 50000,
    "gateway_reference_id": null,
    "txn_list": [
        {
            "refunds": null,
            "txn_detail": {
                "gateway": "LSP",
                "error_message": null,
                "status": "CHARGED",
                "lender_account_details": null,
                "net_amount": 9000,
                "surcharge_amount": null,
                "tax_amount": null,
                "txn_amount": "50000.0",
                "txn_uuid": "mozs24KuurNdf6B8VxF",
                "gateway_id": 1,
                "error_code": null,
                "currency": "INR",
                "created": "2025-03-28 07:52:35.90711 UTC",
                "utr": "5090148756658",
                "settlement": {
                    "processing_fees_gst_amount": 0,
                    "subvention_gst_amount": 567,
                    "processing_fees_amount": 0,
                    "subvention_amount": 3150,
                    "settlement_date": "2025-03-31 09:22:09 UTC",
                    "utr": "509015687958",
                    "tenure": 10,
                    "down_payment_amount": 16667,
                    "settlement_amount": 29381
                },
                "order_id": "OEuwQFr2Ib",
                "txn_id": "testmx-OEuwQ5ty-2"
            },
            "emi_bank": null,
            "bank_error_code": null,
            "status": "CHARGED",
            "bank_error_message": null,
            "txn_intent_id": "LSP7zFqllvLbgfAaL7O68h",
            "txn_uuid": "mozs24K75B8VxF",
            "gateway_id": 1,
            "sub_status": "Loan Active",
            "txn_type": "LOANPAYMENT",
            "resp_message": null,
            "payment_links": null,
            "emi_tenure": 10,
            "resp_code": null,
            "gateway_reference_id": null,
            "refunded": null,
            "payment_method": "MONEY_VIEW_LSP",
            "txn_intent_amount": "50000.0",
            "payment_gateway_response": {
                "epg_txn_id": "MV48-174764528",
                "resp_message": null,
                "created": "2025-03-28 07:52:35.90711 UTC",
                "rrn": "50901754958",
                "resp_code": null,
                "txn_id": "testmx-OEuwQFr2Ib-2"
            },
            "txn_id": "testmx-OEuwQFgh-2",
            "payment_method_type": "MONEY_VIEW_LSP",
            "amount_refunded": null,
            "offer_detail": {
                "interest_amount": 0,
                "processing_fees": 0,
                "interest_rate": 0,
                "advance_emi": null,
                "emi_tenure": 10,
                "emi_amount": 3334,
                "downpayment_amount": 16667,
                "interest_type": "REDUCING"
            }
        }
    ],
    "order_id": "OEuwQFr2Ib",
    "udf7": "",
    "udf10": "",
    "customer_id": "1GwXKYW7aBEVWh10B6xdpQPnC",
    "udf1": ""
}
```

## Path Parameters:

#### order_id:
Order Id of the order for which you want to check the status
- Value: Example:- JP1636474794
- Tags: String, Mandatory
## API Responses:
### 200:

#### id:
- Description: Unique ID generated by JusPay for the given order
- Tags: string, Max Length : 128 

#### order_id:
- Description: OrderId provided in the request
- Tags: string, Max Length : 255 

#### status:
- Description: Status of the order. For information on different order status and handling, refer [here](https://docs.juspay.in/resources/docs/common-resources/transaction-status)
- Tags: string, Max Length : 255  

#### status_id:
- Description: Status ID is a numeric id corresponding to the status value
- Tags: Integer

#### amount:
- Description: The order amount
- Tags: Double

#### date_created:
- Description: Order creation timestamp in UTC

**Example** : 2021-11-09T16:19:55Z
- Tags: string

#### customer_email:
- Description: The email Id of the customer provided during order creation
- Tags: string, Max Length : 300 

#### customer_phone:
- Description: The phone number of the customer provided during order creation
- Tags: string, Max Length : 300 

#### customer_id:
- Description: The customer id provided during order creation
- Tags: string, Max Length : 300 

#### merchant_id:
- Description: The merchant id provided by Juspay
- Tags: string, Max Length : 255 

#### currency:
- Description: The currency provided during order creation. 

**Default:**  INR
- Tags: string, Max Length : 255 

#### return_url:
- Description: The return url provided during order creation
- Tags: string, Max Length : 255 

#### txn_list:
- Description: The json object with the details of the transaction
- Value:
  - **Txn_id**:
    - Tags: String, Max Length : 255
  - **Status**:
    - Description: Following statuses will be provided.
    - Tags: String, Max Length : 255
  - **Resp_code**:
    - Tags: String, Max Length : 255
  - **Currency**:
    - Tags: String, Max Length : 10
  - **Txn_uuid**:
    - Tags: String, Mandatory
  - **Gateway**:
    - Tags: String, Max Length : 128
  - **Error_message**:
    - Tags: String, Max Length : 255
  - **Error_code**:
    - Tags: String, Mandatory
  - **Resp_message**:
    - Tags: String, Mandatory
  - **Payment_method_type**:
    - Value: CONSUMER_FINANCE
    - Tags: String, Mandatory
  - **Payment_method**:
    - Tags: String, Mandatory
  - **Txn_detail**:
    - Value:
      - **Txn_id**:
        - Tags: String, Mandatory
      - **Order_id**:
        - Tags: String, Mandatory
      - **Status**:
        - Tags: String, Mandatory
      - **Error_code**:
        - Tags: String, Mandatory
      - **Txn_amount**:
        - Tags: String, Mandatory
      - **Currency**:
        - Tags: String, Mandatory
      - **Gateway**:
        - Tags: String, Mandatory
      - **Txn_uuid**:
        - Tags: String, Mandatory
      - **Error_message**:
        - Tags: String, Mandatory
      - **Created**:
        - Tags: String, Mandatory
      - **Settlement**:
        - Value:
          - **Subvention_amount**:
            - Tags: String, Mandatory
          - **Utr**:
            - Tags: String, Mandatory
          - **Settlement_amount**:
            - Tags: String, Mandatory
          - **Tenure**:
            - Tags: String, Mandatory
          - **Settlement_date**:
            - Tags: String, Mandatory
          - **Down_payment_amount**:
            - Tags: String, Mandatory
          - **Processing_fee_amount**:
            - Tags: String, Mandatory
          - **Processing_fees_gst_amount**:
            - Tags: String, Mandatory
          - **Subvention_gst_amount**:
            - Tags: String, Mandatory
        - Tags: String, Mandatory
    - Tags: JSON, Mandatory
  - **Sub_status**:
    - Tags: String, Mandatory
  - **Gateway_reference_id**:
    - Tags: String, Mandatory
  - **Payment_gateway_response**:
    - Value:
      - **Rrn**:
        - Tags: String, Mandatory
      - **Resp_code**:
        - Tags: String, Mandatory
      - **Created**:
        - Tags: String, Mandatory
      - **Epg_txn_id**:
        - Tags: String, Mandatory
      - **Resp_message**:
        - Tags: String, Mandatory
      - **Txn_id**:
        - Tags: String, Mandatory
    - Tags: String, Mandatory
  - **Offer_detail**:
    - Value:
      - **Emi_tenure**:
        - Tags: String, Mandatory
      - **Emi_amount**:
        - Tags: String, Mandatory
      - **Interest_rate**:
        - Tags: String, Mandatory
      - **Interest_amount**:
        - Tags: String, Mandatory
      - **Downpayment_amount**:
        - Tags: String, Mandatory
      - **Advance_emi**:
        - Tags: String, Mandatory
      - **Processing_fees**:
        - Tags: String, Mandatory
    - Tags: JSON, Mandatory
- Tags: Array JSON

#### gateway_reference_id:
- Description: The gateway reference id used for the transaction
- Tags: Integer, Max Length : 255 
### 400:

#### status:
- Description: Bad Request
- Tags: string

#### error_code:
- Description: Details of keys missing
- Value: <p>Example:- <br> Mandatory fields are missing </p>
- Tags: string

#### error_message:
- Description: Further Details of keys missing
- Tags: string
### 401:

#### status:
- Description: error
- Tags: string

#### error_code:
- Description: access_denied
- Tags: string
### 500:

#### status:
- Description: error
- Tags: string

#### error_code:
- Description: Internal server Error
- Tags: string


---

## See Also

- [Session API](https://juspay.io/in/docs/hyper-credit/web/base-sdk-integration/session-api)
- [Webhooks](https://juspay.io/in/docs/hyper-credit/web/base-sdk-integration/webhooks)