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

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

Request

Response

API Endpoints

Sandbox Link

GET

https://sandbox.juspay.in/orders/{order_id}

Production Link

GET

https://api.juspay.in/orders/{order_id}

                      version
                      *
                      

String

Required

Pass the date in YYYY-MM-DD format

                      x-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      order_id
                      *
                      

String

Mandatory

Order Id

Example:- ord_7678648

Response Body

id

String

Unique ID generated by JusPay for the given order

                      order_id
                      
                      

String

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

                      status
                      
                      

String

Status of order

                      status_id
                      
                      

String

Status ID is a numeric id corresponding to the status value

                      amount
                      
                      

Double

The order amount

                      date_created
                      
                      

String

Order creation timestamp in UTC

                      customer_email
                      
                      

String

The email Id of the customer passed during order creation

                      customer_phone
                      
                      

String

The phone number of the customer passed during order creation

                      customer_id
                      
                      

String

The customer id passed during order creation

                      merchant_id
                      
                      

String

The merchant id provided by Juspay

                      currency
                      
                      

String

The currency passed during order creation. Default is INR

                      return_url
                      
                      

String

The return url provided during order creation

                      product_id
                      
                      

String

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

                      udf1-udf10
                      
                      

String

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

                      txn_id
                      
                      

String

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
                      
                      

String

Wallet

                      payment_method
                      
                      

String

CRED

                      auth_type
                      
                      

String

                      refunded
                      
                      

Boolean

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
                      
                      

String

Amount which has been refunded so far for the given order

                      refunds
                      
                      

String

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

                      txn_detail
                      
                      

JSON

The json object with the details of the transaction

                      payment_gateway_response
                      
                      

String

The json object with the details receive from PG

                      payment_gateway_response.resp_code
                      
                      

String

Unique ID generated by JusPay for the given order

rrn

String

The bank reference number provided by the gateway

                      created
                      
                      

String

The transaction creation timestamp

                      epg_txn_id
                      
                      

String

Transaction Id from the underlying gateway

                      auth_id_code
                      
                      

String

Auth code provided by the gateway for the transaction.

                      txn_id
                      
                      

String

Transaction Id for the payment attempt

                      resp_message
                      
                      

String

The response message provided by the gateway

                      response
                      
                      

Object

                      gateway_id
                      
                      

String

Gateway Id of the gateway used for performing this transactions