JavaScript is disabled. Some features may not work. You can also read the static version: View text version

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

Warning

This API shouldn't be used to fulfill the orders. The fulfillment of orders should be on the basis of order status of hypercheckout.

Request

Response

API Endpoints

Sandbox Link

GET

https://integ-expresscheckout-api.juspay.in/credit/order/{order_id}'

Production Link

GET

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

                      Basic Auth (copy)
                      *
                      

Base64 Encoded username:password

required

Consists of two parts.

Username: API Key will be share by the credit team
Password: Empty string

Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      *
                      

string

required

Merchant ID provided by Juspay

                      version
                      *
                      

string

required

Pass the date in YYYY-MM-DD format

                      Content-Type
                      *
                      

String

Required

application/x-www-form-urlencoded

                      order_id
                      *
                      

String

Mandatory

Order Id of the order for which you want to check the status

Example:- JP1636474794

Response Body

id

string

Max Length : 128

Unique ID generated by JusPay for the given order

                      order_id
                      
                      

string

Max Length : 255

OrderId provided in the request

                      status
                      
                      

string

Max Length : 255

Status of the order. For information on different order status and handling, refer here

                      status_id
                      
                      

Integer

Status ID is a numeric id corresponding to the status value

                      amount
                      
                      

Double

The order amount

                      date_created
                      
                      

string

Order creation timestamp in UTC

Example: 2021-11-09T16:19:55Z

                      customer_email
                      
                      

string

Max Length : 300

The email Id of the customer provided during order creation

                      customer_phone
                      
                      

string

Max Length : 300

The phone number of the customer provided during order creation

                      customer_id
                      
                      

string

Max Length : 300

The customer id provided during order creation

                      merchant_id
                      
                      

string

Max Length : 255

The merchant id provided by Juspay

                      currency
                      
                      

string

Max Length : 255

The currency provided during order creation.

Default: INR

                      return_url
                      
                      

string

Max Length : 255

The return url provided during order creation

                      txn_list
                      
                      

Array JSON

The json object with the details of the transaction

                      txn_id
                      
                      

String

Max Length : 255

                      status
                      
                      

String

Max Length : 255

Following statuses will be provided.

                      resp_code
                      
                      

String

Max Length : 255

                      currency
                      
                      

String

Max Length : 10

                      txn_uuid
                      *
                      

String

Mandatory

                      gateway
                      
                      

String

Max Length : 128

                      error_message
                      
                      

String

Max Length : 255

                      error_code
                      *
                      

String

Mandatory

                      resp_message
                      *
                      

String

Mandatory

                      payment_method_type
                      *
                      

String

Mandatory

Example:- CONSUMER_FINANCE

                      payment_method
                      *
                      

String

Mandatory

                      txn_detail
                      *
                      

JSON

Mandatory

                      txn_id
                      *
                      

String

Mandatory

                      order_id
                      *
                      

String

Mandatory

                      status
                      *
                      

String

Mandatory

                      error_code
                      *
                      

String

Mandatory

                      txn_amount
                      *
                      

String

Mandatory

                      currency
                      *
                      

String

Mandatory

                      gateway
                      *
                      

String

Mandatory

                      txn_uuid
                      *
                      

String

Mandatory

                      error_message
                      *
                      

String

Mandatory

                      created
                      *
                      

String

Mandatory

                      settlement
                      *
                      

String

Mandatory

                      subvention_amount
                      *
                      

String

Mandatory

                      utr
                      *
                      

String

Mandatory

                      settlement_amount
                      *
                      

String

Mandatory

                      tenure
                      *
                      

String

Mandatory

                      settlement_date
                      *
                      

String

Mandatory

                      down_payment_amount
                      *
                      

String

Mandatory

                      processing_fee_amount
                      *
                      

String

Mandatory

                      processing_fees_gst_amount
                      *
                      

String

Mandatory

                      subvention_gst_amount
                      *
                      

String

Mandatory

                      sub_status
                      *
                      

String

Mandatory

                      gateway_reference_id
                      *
                      

String

Mandatory

                      payment_gateway_response
                      *
                      

String

Mandatory

                      rrn
                      *
                      

String

Mandatory

                      resp_code
                      *
                      

String

Mandatory

                      created
                      *
                      

String

Mandatory

                      epg_txn_id
                      *
                      

String

Mandatory

                      resp_message
                      *
                      

String

Mandatory

                      txn_id
                      *
                      

String

Mandatory

                      offer_detail
                      *
                      

JSON

Mandatory

                      emi_tenure
                      *
                      

String

Mandatory

                      emi_amount
                      *
                      

String

Mandatory

                      interest_rate
                      *
                      

String

Mandatory

                      interest_amount
                      *
                      

String

Mandatory

                      downpayment_amount
                      *
                      

String

Mandatory

                      advance_emi
                      *
                      

String

Mandatory

                      processing_fees
                      *
                      

String

Mandatory

                      gateway_reference_id
                      
                      

Integer

Max Length : 255

The gateway reference id used for the transaction

Response Body

                      status
                      
                      

string

Bad Request

                      error_code
                      
                      

string

Details of keys missing

Example:-
Mandatory fields are missing

                      error_message
                      
                      

string

Further Details of keys missing

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

Internal server Error