---
page_source: https://juspay.io/in/docs/ec-headless/cordova/base-sdk-integration/order-status-api
page_title: Order Status API
---
## API Version: default
# Order Status API
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](https://docs.juspay.in/resources/docs/common-resources/transaction-status)## Endpoints:
- Sandbox: https://sandbox.juspay.in/orders/{order_id}
- Production: https://api.juspay.in/orders/{order_id}
## Request Type:
GET
## Content-Type:
application/json
## Authorization:
#### Basic Auth:
Consists of two parts.
* Username: API Key obtained from Juspay dashboard
* Password: Empty string
- Value: Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
- Tags: Base64 Encoded username:password, required
## Headers:
#### x-merchantid:
Merchant ID provided by Juspay
Example:-merchant-id
- Tags: String, Required
#### Content-Type:
application/x-www-form-urlencoded
- Tags: String
#### x-routing-id:
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.
> **Warning**
> 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.
- Value: customer_1122
- Tags: String, Required
## Sample Code Snippets:
### Sample Response:
#### Card:
```json
{
"customer_email": "test@gmail.com",
"customer_phone": "9999999999",
"customer_id": "testcardenc1",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_57dfd768bb7d4896bc042y0b90bc9ad77",
"merchant_id": "merchant_success",
"amount": 9000,
"currency": "INR",
"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": "2354",
"using_saved_card": true,
"card_fingerprint": "32qqi3sv1u5237fq7ura2rgqqb",
"card_isin": "411111",
"card_type": "CREDIT",
"card_brand": "VISA",
"using_token": false
},
"payment_method": "VISA",
"refunded": true,
"amount_refunded": 9200,
"effective_amount": 9200,
"refunds": [
{
"id": "TEST1637681731",
"amount": 9200,
"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": "RAZORPAY",
"refund_type": "STANDARD",
"metadata": {
"speed_processed": "normal", // only for Razorpay successful refunds
"speed_requested": "normal" // only for Razorpay successful refunds
},
"pg_processed_at": "2022-11-24T08:07:43Z",
"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": 9000,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 9000,
"offer_deduction_amount": 500,
"gateway_id": 23,
"currency": "INR",
"express_checkout": true,
"redirect": true,
"txn_uuid": "eulwh5QbZSBvw35eWnH",
"gateway": "RAZORPAY",
"error_message": "",
"created": "2021-11-09T16:20:52Z",
"txn_amount_breakup": "[{\"name\":\"BASE\",\"value\":9000,\"sno\":1,\"method\":\"ADD\"},{\"name\":\"ADD_ON\",\"value\":500,\"sno\":2,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount1\"},{\"name\":\"ADD_ON\",\"value\":200,\"sno\":3,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount2\"},{\"name\":\"OFFER\",\"value\":500,\"sno\":4,\"method\":\"SUB\"}]"
},
"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": {
"RAZORPAY:gateway_reference_id": "testmid"
},
"gateway_reference_id": "testmid",
"offers": []
}
```
#### Netbanking:
```json
{
"customer_email": "test@gmail.com",
"customer_phone": "9876543210",
"customer_id": "cst_wiqou3224",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_a3cfc9c7f77e4fc581f19aewe23925",
"merchant_id": "merchantId",
"amount": 9000,
"currency": "INR",
"order_id": "JPAYNEW032",
"date_created": "2021-09-10T09:01:36Z",
"return_url": "https://api.juspay.in",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_a3cfc9c7f77e4fc581f19aewe23925",
"web": "https://api.juspay.in/merchant/pay/ordeh_a3cfc9c7f77e4fc581f19aewe23925",
"mobile": "https://api.juspay.in/merchant/pay/ordeh_a3cfc9c7f77e4fc581f19aewe23925?mobile=true"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "merchantId-JPAYNEW032-1",
"payment_method_type": "NB",
"auth_type": "THREE_DS",
"payment_method": "NB_HDFC",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 9700,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "eulbAxqZAR324cwzgo",
"txn_detail": {
"txn_id": "merchantId-JPAYNEW032-1",
"order_id": "JPAYNEW032",
"status": "CHARGED",
"error_code": null,
"net_amount": 9000,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 9000,
"offer_deduction_amount": 500,
"gateway_id": 12,
"currency": "INR",
"express_checkout": false,
"redirect": true,
"txn_uuid": "eulbAxqZAR324cwzgo",
"gateway": "PAYU",
"error_message": "",
"created": "2021-09-10T09:02:03Z",
"txn_amount_breakup": "[{\"name\":\"BASE\",\"value\":9000,\"sno\":1,\"method\":\"ADD\"},{\"name\":\"ADD_ON\",\"value\":500,\"sno\":2,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount1\"},{\"name\":\"ADD_ON\",\"value\":200,\"sno\":3,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount2\"}]"
},
"payment_gateway_response": {
"resp_code": "success",
"rrn": "45903248",
"created": "2021-09-10T09:02:55Z",
"epg_txn_id": "40399371553295730",
"resp_message": "No Error",
"auth_id_code": "2732147",
"txn_id": "merchantId-JPAYNEW032-1"
},
"gateway_id": 12,
"gateway_reference_id": null,
"offers": []
}
```
#### Wallets:
```json
{
"udf9": "",
"udf8": "",
"udf7": "",
"udf6": "",
"udf5": "",
"udf4": "",
"udf3": "",
"udf2": "",
"udf10": "",
"udf1": "",
"txn_uuid": "eulneT9JkaAPa1uv",
"txn_id": "merchantId-145678234-1",
"txn_detail": {
"txn_uuid": "eulneT9JkaAPa1uv",
"txn_id": "merchantId-145678234-1",
"txn_amount": 1,
"tax_amount": null,
"surcharge_amount": null,
"status": "CHARGED",
"redirect": false,
"order_id": "145678234",
"net_amount": 1,
"gateway_id": 19,
"gateway": "PAYTM_V2",
"express_checkout": false,
"error_message": "",
"error_code": "",
"currency": "INR",
"created": "2020-04-28T06:31:37Z"
},
"status_id": 21,
"status": "CHARGED",
"return_url": "https://api.juspay.in/end",
"refunds": [
{
"unique_request_id": "refund_1590649567",
"status": "SUCCESS",
"sent_to_gateway": true,
"ref": "2020052811128464733807",
"initiated_by": "API",
"id": null,
"error_message": "Refund Successfull",
"created": "2020-04-28T07:06:07Z",
"arn": "0149717932",
"amount": 1
}
],
"refunded": true,
"product_id": "",
"payment_method_type": "WALLET",
"payment_method": "GOOGLEPAY",
"payment_links": {
"web": "https://api.juspay.in/merchant/pay/ordeu_f19a2a9da6034a269f03424dbda0",
"mobile": "https://api.juspay.in/merchant/pay/ordeu_f19a2a9da6034a269f03424dbda0?mobile=true",
"iframe": "https://api.juspay.in/merchant/ipay/ordeu_f19a2a9da6034a269f03424dbda0"
},
"payment_gateway_response": {
"txn_id": "merchantId-145678234-1",
"rrn": "01491223245566834",
"resp_message": "Txn Success",
"resp_code": "01",
"epg_txn_id": "20200528800110849227184",
"created": "2020-04-28T06:54:35Z",
"auth_id_code": ""
},
"payer_vpa": "null",
"order_id": "145678234",
"merchant_id": "merchant_id",
"id": "ordeu_f19a2a9da6034a269f03424dbda0",
"gateway_reference_id": "gatewayreferenceId",
"gateway_id": 19,
"date_created": "2020-04-28T06:31:09Z",
"customer_phone": "9999999999",
"customer_id": "test_customer",
"customer_email": "test007@gmail.com",
"currency": "INR",
"bank_error_message": "",
"bank_error_code": "",
"auth_type": "",
"amount_refunded": 1,
"amount": 1
}
```
#### UPI:
```plaintext
{
"customer_email": "test@gmail.com",
"customer_phone": "9876543210",
"customer_id": "cst_wiqou3224",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_ce50b4861d2b4b3e9bf3r3r2rid3”,
"merchant_id": "merchantId”,
"amount": 2,
"currency": "INR",
"order_id": "JPAYNEW034",
"date_created": "2021-09-10T09:06:53Z",
"return_url": "https://api.juspay.in",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"web": "https://api.juspay.in/merchant/pay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"mobile": "https://api.juspay.in/merchant/pay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3?mobile=true"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "merchantId-JPAYNEW034-1",
"payment_method_type": "UPI",
"auth_type": "",
"payment_method": "UPI",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 2,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "eulk1HvJ29o9dJ344x4f",
"txn_detail": {
"txn_id": "merchantId-JPAYNEW034-1",
"order_id": "JPAYNEW034",
"status": "CHARGED",
"error_code": null,
"net_amount": 2,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 2,
"offer_deduction_amount": null,
"gateway_id": 23,
"currency": "INR",
"express_checkout": false,
"redirect": false,
"txn_uuid": "eulk1HvJ29o9dJ344x4f",
"gateway": "RAZORPAY",
"error_message": "",
"created": "2021-09-10T09:07:10Z"
},
"payment_gateway_response": {
"resp_code": "captured",
"rrn": "868709664362",
"created": "2021-09-10T09:07:39Z",
"epg_txn_id": "pay_HvhtO3324opPPs",
"resp_message": "",
"auth_id_code": "",
"txn_id": "merchantId-JPAYNEW034-1"
},
"gateway_id": 23,
"payer_vpa": "9876543210@ybl",
"upi": {
"payer_vpa": "9876543210@ybl",
"txn_flow_type": "COLLECT"
},
"gateway_reference_id": null,
"offers": []
}
```
#### Debit + Enach (Split Payment):
```plaintext
{
"customer_email": "josshithas@gmail.com",
"customer_phone": "6369288401",
"customer_id": "cth_i2M96SkyFXJXSQvr",
"customer_phone_country_code": null,
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"merchant_id": "mandate_juspay",
"amount": 1,
"currency": "INR",
"order_id": "Ord_1484kmOH",
"date_created": "2025-07-09T06:41:24Z",
"last_updated": "2025-07-09T06:41:42Z",
"return_url": "https://juspay.in/",
"product_id": "",
"payment_links": {
"mobile": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"web": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"iframe": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 2,
"metadata": {
"split_payment_reference": "DEBIT_ENACH",
"allow_split_txn_when_oid_equals_txnid_enabled": false,
"order_expiry": "2025-07-10T06:41:24Z",
"payment_page_client_id": "mandatejuspay",
"PAYTM_V2:gateway_reference_id": "test_enach",
"payment_links": {
"mobile": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"web": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"iframe": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3"
}
},
"txn_list": [
{
"txn_id": "M-Ord_1484kmOH-1-1",
"payment_method_type": "NB",
"auth_type": "THREE_DS",
"payment_method": "NB_HDFC",
"refunded": false,
"effective_amount": 1,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "mozaPZxSa8dnGoe5Ubw",
"txn_detail": {
"txn_id": "M-Ord_1484kmOH-1-1",
"order_id": "Ord_1484kmOH",
"status": "CHARGED",
"error_code": null,
"net_amount": 1,
"surcharge_amount": 0,
"tax_amount": 0,
"txn_amount": 1,
"offer_deduction_amount": null,
"remaining_refundable_amount": 1,
"gateway_id": 19,
"currency": "INR",
"express_checkout": false,
"redirect": true,
"txn_uuid": "mozaPZxSa8dnGoe5Ubw",
"gateway": "PAYTM_V2",
"error_message": "",
"created": "2025-07-09T06:41:24Z",
"last_updated": "2025-07-09T06:41:42Z",
"txn_flow_type": "NET_BANKING",
"txn_amount_breakup": [
{
"name": "BASE",
"amount": 1,
"sno": 1,
"method": "ADD"
},
{
"name": "SURCHARGE",
"amount": 0,
"sno": 2,
"method": "ADD"
},
{
"name": "TAX_ON_SURCHARGE",
"amount": 0,
"sno": 3,
"method": "ADD"
}
]
},
"payment_gateway_response": {
"resp_code": "01",
"rrn": "10100680908",
"created": "2025-07-09T06:41:42Z",
"epg_txn_id": "20250709211430000149678400718746052",
"resp_message": "Txn Success",
"auth_id_code": "",
"txn_id": "M-Ord_1484kmOH-1-1",
"gateway_response": {
"bankName": "HDFC Bank",
"bankResultInfo": {
"bankResultCode": "SUCCESS",
"bankResultMsg": "Success"
},
"bankTxnId": "10100680908",
"gatewayName": "HDFC",
"merchantUniqueReference": "NA",
"mid": "Juspay67815894107156",
"orderId": "M-Ord_1484kmOH-1-1",
"paymentMode": "NB",
"refundAmt": "0.0",
"resultCode": "01",
"resultInfo": {
"resultStatus": "TXN_SUCCESS",
"resultCode": "01",
"resultMsg": "Txn Success"
},
"resultMsg": "Txn Success",
"resultStatus": "TXN_SUCCESS",
"txnAmount": "1.00",
"txnDate": "2025-07-09 12:11:30.0",
"txnId": "20250709211430000149678400718746052",
"txnType": "SALE"
},
"network_error_message": null,
"network_error_code": null,
"arn": "",
"gateway_merchant_id": "Juspay67815894107156",
"eci": null,
"auth_ref_num": null,
"umrn": null,
"current_blocked_amount": null,
"payer_ifsc": null,
"xid": null,
"cvv_check": null
},
"gateway_id": 19,
"gateway_reference_id": "test_enach",
"emi_details": {
"bank": null,
"monthly_payment": null,
"interest": null,
"subvention_amount": null,
"conversion_details": null,
"principal_amount": null,
"additional_processing_fee_info": null,
"tenure": null,
"subvention_info": [],
"emi_type": null,
"processed_by": null
},
"metadata": {
"split_payment_reference": "DEBIT_ENACH",
"allow_split_txn_when_oid_equals_txnid_enabled": false,
"order_expiry": "2025-07-10T06:41:24Z",
"payment_page_client_id": "mandatejuspay",
"PAYTM_V2:gateway_reference_id": "test_enach",
"payment_links": {
"mobile": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"web": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"iframe": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3"
}
},
"offers": [],
"status": "CHARGED",
"resp_category": null
},
{
"txn_id": "M-Ord_1484kmOH-1-2",
"payment_method_type": "NB",
"auth_type": "THREE_DS",
"payment_method": "JP_HDFC",
"refunded": false,
"effective_amount": 1,
"mandate": {
"mandate_token": "f3f5c3ee63c44a7ea6869cead3223d27",
"mandate_status": "CREATED",
"mandate_id": "8bx1yHx4haSKFmgC8brRHb",
"bank_details": {
"account_number": "282800002828",
"id": null,
"ifsc": "HDFC0001961",
"bank_account_type": "SAVINGS",
"beneficiary_name": "Bowmitha",
"bank_name": "HDFC Bank"
},
"mandate_type": "EMANDATE",
"start_date": "1752043284",
"end_date": "1752907284",
"revokable_by_customer": true,
"block_fund": false,
"max_amount": 50,
"frequency": "ASPRESENTED",
"amount_rule": "VARIABLE",
"next_execution_info": {
"next_execution_date": null,
"next_execution_amount": null
}
},
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "mozwSQmm75WawRFfqq5",
"txn_detail": {
"txn_id": "M-Ord_1484kmOH-1-2",
"order_id": "Ord_1484kmOH",
"status": "AUTHORIZING",
"error_code": null,
"net_amount": 1,
"surcharge_amount": 0,
"tax_amount": 0,
"txn_amount": 1,
"offer_deduction_amount": null,
"remaining_refundable_amount": 1,
"gateway_id": 19,
"currency": "INR",
"express_checkout": false,
"redirect": true,
"txn_uuid": "mozwSQmm75WawRFfqq5",
"gateway": "PAYTM_V2",
"error_message": "",
"txn_object_type": "EMANDATE_REGISTER",
"source_object": "MANDATE",
"source_object_id": "100020052996",
"created": "2025-07-09T06:41:24Z",
"last_updated": "2025-07-14T08:11:34Z",
"txn_flow_type": "NET_BANKING",
"txn_amount_breakup": [
{
"name": "BASE",
"amount": 1,
"sno": 1,
"method": "ADD"
},
{
"name": "SURCHARGE",
"amount": 0,
"sno": 2,
"method": "ADD"
},
{
"name": "TAX_ON_SURCHARGE",
"amount": 0,
"sno": 3,
"method": "ADD"
}
]
},
"payment_gateway_response": {
"resp_code": "3006",
"rrn": "",
"created": "2025-07-09T06:46:26Z",
"epg_txn_id": "M-Ord_1484kmOH-1-2",
"resp_message": "SUCCESS",
"auth_id_code": "",
"txn_id": "M-Ord_1484kmOH-1-2",
"gateway_response": {
"amountType": "VARIABLE",
"createdDate": "2025-07-09 12:11:43",
"custEmailId": "josshithas@gmail.com",
"custId": "cth_i2M96SkyFXJXSQvr",
"custMobileNo": "6369288401",
"expiryDate": "2025-07-19 00:00:00",
"lastOrderAmount": "0.0",
"lastOrderCreationDate": "2025-07-09 12:11:43.11",
"lastOrderId": "M-Ord_1484kmOH-1-2",
"lastOrderStatus": "PENDING",
"maxAmount": "50.0",
"merchantName": "Juspay",
"mid": "Juspay67815894107156",
"orderId": "M-Ord_1484kmOH-1-2",
"resultInfo": {
"status": "SUCCESS",
"message": "SUCCESS",
"code": "3006"
},
"status": "IN_AUTHORIZATION",
"subStatus": "NPCI_PENDING",
"subsId": "989708",
"subsPaymentInstDetails": {
"paymentMode": "BANK_MANDATE",
"bankName": "HDFC Bank",
"ifsc": "HDFC0001961",
"bankLogo": "https://static4.paytmpayments.com/native/bank/HDFC.png",
"maskedAccountNumber": "XXXXXXXX2828",
"mandateType": "E_MANDATE"
},
"updatedDate": "2025-07-09 12:11:44"
},
"network_error_message": null,
"network_error_code": null,
"arn": "",
"gateway_merchant_id": "Juspay67815894107156",
"eci": null,
"auth_ref_num": null,
"umrn": null,
"current_blocked_amount": null,
"payer_ifsc": null,
"xid": null,
"cvv_check": null
},
"gateway_id": 19,
"gateway_reference_id": "test_enach",
"emi_details": {
"bank": null,
"monthly_payment": null,
"interest": null,
"subvention_amount": null,
"conversion_details": null,
"principal_amount": null,
"additional_processing_fee_info": null,
"tenure": null,
"subvention_info": [],
"emi_type": null,
"processed_by": null
},
"metadata": {
"split_payment_reference": "DEBIT_ENACH",
"allow_split_txn_when_oid_equals_txnid_enabled": false,
"order_expiry": "2025-07-10T06:41:24Z",
"payment_page_client_id": "mandatejuspay",
"PAYTM_V2:gateway_reference_id": "test_enach",
"payment_links": {
"mobile": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"web": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3",
"iframe": "https://sandbox.assets.juspay.in/payment-page/order/ordeh_396edaa0ef7e462e9770d4f402b29bb3"
}
},
"offers": [],
"status": "AUTHORIZING",
"resp_category": null
}
],
"additional_info": {}
}
```
## Path Parameters:
#### order_id:
Order Id of the order for which you want to check the status
- Value: Example:- JP1636474794
- Tags: String, Mandatory
## Query Parameters:
#### options.add_full_gateway_response:
You may include this query param set as **true** to receive the complete response as received from the payment gateway.
- Tags: Boolean, Optional
## 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
#### product_id:
- Description: The product_id provided during order creation
- Tags: string, Max Length : 64
#### udf1-udf10:
- Description: The user defined fields passed during order creation. Empty in case not passed
- Tags: string, Max Length : 255
#### 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. In case of Debit + ENach, it will be part of txn_list
- Tags: string, Max Length : 255
#### payment_method_type:
- Description: The payment method type used for transaction. Possible values are CARD, NB, WALLET, UPI, CONSUMER_FINANCE
- Tags: string, Max Length : 20
#### payment_method:
- Description: The payment method used for the transaction
- Tags: string, Max Length : 20
#### auth_type:
- Description: Possible values `THREE_DS`, `OTP`, `VIES`
- Tags: string, Max Length : 30
#### refunded:
- Description: **true** if the order has been completely refunded
**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: Double
#### refunds:
- Description: The refund block with the details of refund initiated for the given order.
- Value:
- **Unique_request_id**:
- Description: The unique request id provided during refund initiation
- Tags: String, Max Length : 255
- **Status**:
- Description: The status of the refund initiated. Initial status will always be PENDING
- Value: Values can be SUCCESS, FAILURE, PENDING, MANUAL_REVIEW
- Tags: String, Max Length : 255
- **Sent_to_gateway**:
- Description: The flag denotes if the refund was initiated to gateway. The initial status is always false, as refunds are queued at juspay for a period of 15 minutes
- Tags: Boolean
- **Refund_type**:
- Description: The type of refund. Values can be STANDARD, INSTANT
- Tags: String, Max Length : 255
- **Refund_source**:
- Description: The name of gateway from which amount is refunded
- Tags: String, Max Length : 255
- **Ref**:
- Description: The refund id provided by the PG
- Tags: String, Max Length : 64
- **Initiated_by**:
- Description: The source of initiation
- Tags: String, Max Length : 100
- **Id**:
- Description: The reference id provided by PG, if not available then its mapped to unique request id.
- Tags: String
- **Amount**:
- Description: The refund amount passed in the request
- Tags: Double
- **Created**:
- Description: The timestamp of refund creation
- Tags: String
- **Error_message**:
- Tags: String, Max Length : 255
- **Error_code**:
- Tags: String, Max Length : 64
- Tags: Array of Objects
#### 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, Max Length : 128
#### txn_detail:
- Description: The json object with the details of the transaction
- Value:
- **Txn_id**:
- Tags: String, Max Length : 255
- **Order_id**:
- Tags: String, Max Length : 255
- **Status**:
- Tags: String, Max Length : 255
- **Error_code**:
- Tags: String, Max Length : 255
- **Currency**:
- Tags: String, Max Length : 10
- **Txn_uuid**:
- Tags: String, Max Length : 128
- **Gateway**:
- Tags: String, Max Length : 128
- **Error_message**:
- Tags: String, Max Length : 255
- **Txn_amount_breakup**:
- Description: This field details the amount charged to the payer, broken down into "BASE" and/or "ADD_ON" / "OFFER" / "SURCHARGE" / "TAX_ON_SURCHARGE" components (as applicable). Each component outlines the sequence and type of operations applied to the “BASE” amount.
- Value:
- **Name**:
- Description: Name of the component.
- Value: "BASE" and/or "ADD_ON" / "OFFER" / "SURCHARGE" / "TAX_ON_SURCHARGE"
- Tags: String, Mandatory
- **Value**:
- Description: Value or amount of the component.
- Tags: Double, Mandatory
- **Sno**:
- Description: Sequence number of the operation of the component
- Value: For the BASE component, sno will be 1, increasing per component.
- Tags: Integer, Mandatory
- **Method**:
- Description: "ADD" if component is to be added, "SUB" if component is to be subtracted.
- Value: "ADD" or "SUB"
- Tags: String, Mandatory
- **Desc**:
- Description: This will be present only for custom add on amounts defined by the merchant, which must be added or subtracted from the order amount. Value will be the name assigned by you while creating the order with **add_on_amount_rules** .
- Tags: String, Optional
- Tags: string, Mandatory, Array
- Tags: JSON
#### payment_gateway_response:
- Description: The json object with the details receive from PG
- Value:
- **Payment_gateway_response.resp_code**:
- Description: The response code provided by the gateway
- Tags: string, Max Length : 64
- **Payment_gateway_response.rrn**:
- Description: The bank reference number provided by the gateway
- Tags: string
- **Payment_gateway_response.created**:
- Description: The transaction creation timestamp
- Tags: string
- **Payment_gateway_response.epg_txn_id**:
- Description: Transaction Id from the underlying gateway
- Tags: string
- **Payment_gateway_response.auth_id_code**:
- Description: Auth code provided by the gateway for the transaction.
- Tags: string
- **Payment_gateway_response.txn_id**:
- Description: Transaction Id for the payment attempt
- Tags: string, Max Length : 255
- **Payment_gateway_response.resp_message**:
- Description: The response message provided by the gateway
- Tags: string, Max Length : 512
- **Payment_gateway_response.offer_type**:
- Description: The type of offer applied provided by the gateway( available only if offers are applied)
- Tags: string
- **Payment_gateway_response.offer_availed**:
- Description: true if the offer is applied at the payment gateway. Else it will be false ( available only if offers are applied)
- Tags: Boolean
- **Payment_gateway_response.discount_amount**:
- Description: The discount amount provided by the gateway for the availed offer ( available only if offers are applied)
- Tags: Double
- Tags: JSON
#### gateway_id:
- Description: Gateway Id of the gateway used for performing this transactions (Refer [here](https://docs.juspay.in/resources/docs/dynamic-routing/dynamic-routing#Enforce-Gateway-Routing) for mapping)
- Tags: Integer
#### gateway_reference_id:
- Description: The gateway reference id used for the transaction
- Tags: Integer, Max Length : 255
#### 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, Max Length : 256
- **Card_reference**:
- Description: A reference identifier for the card.
- Tags: string, Max Length : 256
- **Expiry_month**:
- Description: The expiry month of the card used for the transaction
- Tags: string, Max Length : 256
- **Saved_to_locker**:
- Description: true if card was saved to locker, else false
- Tags: Boolean
- **Name_on_card**:
- Description: The name on card used for the transaction
- Tags: string, Max Length : 256
- **Card_issuer**:
- Description: Indicates the bank which issued the card
- Tags: string, Max Length : 256
- **Last_four_digits**:
- Description: The last four digit of the card used
- Tags: string, Max Length : 256
- **Using_saved_card**:
- Description: **true** if transaction was done via a saved card
**false** if transaction via new card/unsaved card
- Tags: Boolean
- **Card_fingerprint**:
- Description: The unique identifier for the card
- Tags: string, Max Length : 256
- **Card_isin**:
- Description: The first six digit of the card used for the transaction
- Tags: string, Max Length : 256
- **Card_type**:
- Description: Indicates if the card is either CREDIT or DEBIT
- Tags: string, Max Length : 64
- **Card_brand**:
- Description: The provider of the card, can be VISA, RUPAY etc.
- Tags: string
- Tags: JSON
#### second_factor_response:
- Description: This will contain the authentication response which can be used to perform authorization directly. this will be available for 15 mins after user has completed the authentication. Applicable for txn_type = AUTHENTICATION
#### Second Factor Response Code Snippet:
```second factor response
curl --location --request POST 'https://api.juspay.in/session' \
--header 'x-merchantid: yourMerchantId' \
--header 'Authorization: Basic base64encodedkey==' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount":"10.00",
"order_id":"yourUniqueOrderId",
"customer_id":"dummyCustId",
"customer_phone":"9876543210",
"customer_email":"dummyemail@gmail.com",
"payment_page_client_id":"",
"action":"paymentPage"
}'
```
- Value:
- **Authentication**:
- Description: Contains the json payload
- Tags: Json, Mandatory
- **Authentication.eci**:
- Description: contains the eci value
- Tags: String, Mandatory
- **Authentication.cavv**:
- Description: contains the cavv value
- Tags: String, Mandatory
- **Authentication.threeDSVersion**:
- Description: contains the threeDs version
- Tags: String, Mandatory
- **Authentication.threeDSTransStatusReason**:
- Description: contains the threeDs status reason
- Tags: String, Mandatory
- **Authentication.threeDSServerTransID**:
- Description: contains the threeDs Server Transaction ID
- Tags: String, Mandatory
- **Authentication.threeDSTransStatus**:
- Description: contains the threeDs transaction status
- Tags: String, Mandatory
- **Authentication.cavvAlgorithm**:
- Description: contains the cavv algorithm value
- Tags: String, Mandatory
- Tags: Json
#### authorization:
- Description: This block contains the authorization successful param which can be used to perform capture call. Applicable for txn_type: AUTHORIZATION, AUTHN_AUTHZ, CAPTURE, AUTHZ_CAPTURE
- Value:
- **AuthIdCode**:
- Description: Auth Id Code to be used for performing capture
- Tags: String, Mandatory
- **AcquirerBin**:
- Description: acquirer Bin details, if shared by PG
- Tags: Optional, Mandatory
- **AcquirerMId**:
- Description: acquirer Mid details, if shared by PG
- Tags: Optional, Mandatory
- Tags: String, Mandatory
#### txn_list:
- Description: An array containing the details of individual transactions associated with the order. **This is for Split payment flows**
- Value:
- **Txn_id**:
- Value: M-Ord_1484kmOH-1-1
- Tags: String
- **Payment_method_type**:
- Value: NB
- Tags: String
- **Auth_type**:
- Value: THREE_DS
- Tags: String
- **Payment_method**:
- Value: NB_HDFC
- Tags: String
- **Refunded**:
- Value: false
- Tags: Boolean
- **Effective_amount**:
- Value: 1
- Tags: String
- **Resp_code**:
- **Resp_message**:
- **Bank_error_code**:
- Tags: String
- **Bank_error_message**:
- Tags: String
- **Txn_uuid**:
- Value: mozaPZxSa8dnGoe5Ubw
- Tags: String
- **Txn_detail**:
- Value:
- **Txn_id**:
- Value: M-Ord_1484kmOH-1-1
- Tags: String
- **Order_id**:
- Value: Ord_1484kmOH
- Tags: String
- **Status**:
- Value: CHARGED
- Tags: String
- **Net_amount**:
- Value: 1
- Tags: String
- **Gateway_id**:
- Value: 19
- Tags: String
- **Currency**:
- Value: INR
- Tags: String
- **Gateway**:
- Value: PAYTM_V2
- Tags: String
- **Created**:
- Value: 2025-07-09T06:41:24Z
- Tags: String
- **Txn_flow_type**:
- Value: NET_BANKING
- Tags: String
- Tags: Object
- **Payment_gateway_response**:
- Value:
- **Resp_code**:
- Value: 01
- Tags: String
- **Rrn**:
- Value: 10100680908
- Tags: String
- **Created**:
- Value: 2025-07-09T06:41:42Z
- Tags: String
- **Epg_txn_id**:
- Value: 20250709211430000149678400718746052
- Tags: String
- **Resp_message**:
- Value: Txn Success
- Tags: String
- **Txn_id**:
- Value: M-Ord_1484kmOH-1-1
- Tags: String
- Tags: Object
- **Gateway_id**:
- Value: 19
- Tags: String
- **Status**:
- Value: CHARGED
- Tags: String
- Tags: Array, Conditional
### 400:
#### status:
- Description: Bad Request
- Tags: string
#### error_code:
- Description: Details of keys missing
- Value: Example:-
Mandatory fields are missing
- 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
---
## API Version: V4 - JWE/JWT Encrypted
# Order Status API
> **Error**
> Please follow the [Guide](https://juspay.io/in/docs/api-reference/docs/express-checkout/jwejwt-encryption-guide) for Encryption and Decryption Process
This is a Server-to-Server API that returns the status of the order along with other details in encrypted formate. 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](https://docs.juspay.in/resources/docs/common-resources/transaction-status)
> **Warning**
> Encrypted Payload can be pass as query param or body param.If the encrypted payload is passed as a query parameter, then HTTP method should be GET. If the encrypted payload is passed in the body, then HTTP method should be POST.
## Endpoints:
- Sandbox: https://sandbox.juspay.in/v4/order-status
- Production: https://api.juspay.in/v4/order-status
## Request Type:
GET
## Content-Type:
application/json
## Authorization:
#### Basic Auth:
Consists of two parts.
* Username: API Key obtained from Juspay dashboard
* Password: Empty string
- Value: Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
- Tags: Base64 Encoded username:password, required
## Headers:
#### x-merchantid:
Merchant ID provided by Juspay
- Value: Example:-
merchant-id
- Tags: string
#### Content-Type:
application/JSON
- Tags: String, Required
#### x-routing-id:
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.
> **Warning**
> 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.
- Value: customer_1122
- Tags: String, Required
## Sample Code Snippets:
### Sample Request:
#### Raw - Request Code Snippet:
```raw - request
curl --location --request GET 'https://api.juspay.in/orders/JP1636474794' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-merchantid: merchant_id'\
--header 'Authorization: Basic OTc5Mzcx*****czRTlGOg=='
```
#### Encrypted - Request Code Snippet:
```encrypted - request
curl --location 'https://sandbox.juspay.in/v4/order-status' \
--header 'Content-Type: application/json' \
--header 'x-merchantid: *****' \
--header 'Authorization: Basic ***********************' \
--data '{
"JWT": "******** Add Encrypted payload Here *********************************************************************************************************************************************************"
}
'
```
### Sample Response:
#### Raw - Card:
```json
{
"customer_email": "test@gmail.com",
"customer_phone": "9999999999",
"customer_id": "testcardenc1",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_57dfd768bb7d4896bc042y0b90bc9ad77",
"merchant_id": "merchant_success",
"amount": 9000,
"currency": "INR",
"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": "2354",
"using_saved_card": true,
"card_fingerprint": "32qqi3sv1u5237fq7ura2rgqqb",
"card_isin": "411111",
"card_type": "CREDIT",
"card_brand": "VISA",
"using_token": false
},
"payment_method": "VISA",
"refunded": true,
"amount_refunded": 9200,
"effective_amount": 9200,
"refunds": [
{
"id": "TEST1637681731",
"amount": 9200,
"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": "RAZORPAY",
"refund_type": "STANDARD",
"metadata": {
"speed_processed": "normal", // only for Razorpay successful refunds
"speed_requested": "normal" // only for Razorpay successful refunds
},
"pg_processed_at": "2022-11-24T08:07:43Z",
"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": 9000,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 9000,
"offer_deduction_amount": 500,
"gateway_id": 23,
"currency": "INR",
"express_checkout": true,
"redirect": true,
"txn_uuid": "eulwh5QbZSBvw35eWnH",
"gateway": "RAZORPAY",
"error_message": "",
"created": "2021-11-09T16:20:52Z",
"txn_amount_breakup": "[{\"name\":\"BASE\",\"value\":9000,\"sno\":1,\"method\":\"ADD\"},{\"name\":\"ADD_ON\",\"value\":500,\"sno\":2,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount1\"},{\"name\":\"ADD_ON\",\"value\":200,\"sno\":3,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount2\"},{\"name\":\"OFFER\",\"value\":500,\"sno\":4,\"method\":\"SUB\"}]"
},
"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": {
"RAZORPAY:gateway_reference_id": "testmid"
},
"gateway_reference_id": "testmid",
"offers": []
}
```
#### Raw - Wallets:
```json
{
"udf9": "",
"udf8": "",
"udf7": "",
"udf6": "",
"udf5": "",
"udf4": "",
"udf3": "",
"udf2": "",
"udf10": "",
"udf1": "",
"txn_uuid": "eulneT9JkaAPa1uv",
"txn_id": "merchantId-145678234-1",
"txn_detail": {
"txn_uuid": "eulneT9JkaAPa1uv",
"txn_id": "merchantId-145678234-1",
"txn_amount": 1,
"tax_amount": null,
"surcharge_amount": null,
"status": "CHARGED",
"redirect": false,
"order_id": "145678234",
"net_amount": 1,
"gateway_id": 19,
"gateway": "PAYTM_V2",
"express_checkout": false,
"error_message": "",
"error_code": "",
"currency": "INR",
"created": "2020-04-28T06:31:37Z"
},
"status_id": 21,
"status": "CHARGED",
"return_url": "https://api.juspay.in/end",
"refunds": [
{
"unique_request_id": "refund_1590649567",
"status": "SUCCESS",
"sent_to_gateway": true,
"ref": "2020052811128464733807",
"initiated_by": "API",
"id": null,
"error_message": "Refund Successfull",
"created": "2020-04-28T07:06:07Z",
"arn": "0149717932",
"amount": 1
}
],
"refunded": true,
"product_id": "",
"payment_method_type": "WALLET",
"payment_method": "GOOGLEPAY",
"payment_links": {
"web": "https://api.juspay.in/merchant/pay/ordeu_f19a2a9da6034a269f03424dbda0",
"mobile": "https://api.juspay.in/merchant/pay/ordeu_f19a2a9da6034a269f03424dbda0?mobile=true",
"iframe": "https://api.juspay.in/merchant/ipay/ordeu_f19a2a9da6034a269f03424dbda0"
},
"payment_gateway_response": {
"txn_id": "merchantId-145678234-1",
"rrn": "01491223245566834",
"resp_message": "Txn Success",
"resp_code": "01",
"epg_txn_id": "20200528800110849227184",
"created": "2020-04-28T06:54:35Z",
"auth_id_code": ""
},
"payer_vpa": "null",
"order_id": "145678234",
"merchant_id": "merchant_id",
"id": "ordeu_f19a2a9da6034a269f03424dbda0",
"gateway_reference_id": "gatewayreferenceId",
"gateway_id": 19,
"date_created": "2020-04-28T06:31:09Z",
"customer_phone": "9999999999",
"customer_id": "test_customer",
"customer_email": "test007@gmail.com",
"currency": "INR",
"bank_error_message": "",
"bank_error_code": "",
"auth_type": "",
"amount_refunded": 1,
"amount": 1
}
```
#### Raw - Netbanking:
```json
{
"customer_email": "test@gmail.com",
"customer_phone": "9876543210",
"customer_id": "cst_wiqou3224",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_a3cfc9c7f77e4fc581f19aewe23925",
"merchant_id": "merchantId",
"amount": 9000,
"currency": "INR",
"order_id": "JPAYNEW032",
"date_created": "2021-09-10T09:01:36Z",
"return_url": "https://api.juspay.in",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_a3cfc9c7f77e4fc581f19aewe23925",
"web": "https://api.juspay.in/merchant/pay/ordeh_a3cfc9c7f77e4fc581f19aewe23925",
"mobile": "https://api.juspay.in/merchant/pay/ordeh_a3cfc9c7f77e4fc581f19aewe23925?mobile=true"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "merchantId-JPAYNEW032-1",
"payment_method_type": "NB",
"auth_type": "THREE_DS",
"payment_method": "NB_HDFC",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 9700,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "eulbAxqZAR324cwzgo",
"txn_detail": {
"txn_id": "merchantId-JPAYNEW032-1",
"order_id": "JPAYNEW032",
"status": "CHARGED",
"error_code": null,
"net_amount": 9000,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 9000,
"offer_deduction_amount": 500,
"gateway_id": 12,
"currency": "INR",
"express_checkout": false,
"redirect": true,
"txn_uuid": "eulbAxqZAR324cwzgo",
"gateway": "PAYU",
"error_message": "",
"created": "2021-09-10T09:02:03Z",
"txn_amount_breakup": "[{\"name\":\"BASE\",\"value\":9000,\"sno\":1,\"method\":\"ADD\"},{\"name\":\"ADD_ON\",\"value\":500,\"sno\":2,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount1\"},{\"name\":\"ADD_ON\",\"value\":200,\"sno\":3,\"method\":\"ADD\",\"desc\":\"SampleAddOnAmount2\"}]"
},
"payment_gateway_response": {
"resp_code": "success",
"rrn": "45903248",
"created": "2021-09-10T09:02:55Z",
"epg_txn_id": "40399371553295730",
"resp_message": "No Error",
"auth_id_code": "2732147",
"txn_id": "merchantId-JPAYNEW032-1"
},
"gateway_id": 12,
"gateway_reference_id": null,
"offers": []
}
```
#### Raw - UPI - Intent:
```plaintext
{
"customer_email": "test@gmail.com",
"customer_phone": "9876543210",
"customer_id": "cst_wiqou3224",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"merchant_id": "merchantId",
"amount": 2,
"currency": "INR",
"order_id": "JPAYNEW034",
"date_created": "2021-09-10T09:06:53Z",
"return_url": "https://api.juspay.in",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"web": "https://api.juspay.in/merchant/pay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"mobile": "https://api.juspay.in/merchant/pay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3?mobile=true"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "merchantId-JPAYNEW034-1",
"payment_method_type": "UPI",
"auth_type": "",
"payment_method": "UPI",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 2,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "eulk1HvJ29o9dJ344x4f",
"txn_detail": {
"txn_id": "merchantId-JPAYNEW034-1",
"order_id": "JPAYNEW034",
"status": "CHARGED",
"error_code": null,
"net_amount": 2,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 2,
"offer_deduction_amount": null,
"gateway_id": 23,
"currency": "INR",
"express_checkout": false,
"redirect": false,
"txn_uuid": "eulk1HvJ29o9dJ344x4f",
"gateway": "RAZORPAY",
"error_message": "",
"created": "2021-09-10T09:07:10Z"
},
"payment_gateway_response": {
"resp_code": "captured",
"rrn": "868709664362",
"created": "2021-09-10T09:07:39Z",
"epg_txn_id": "pay_HvhtO3324opPPs",
"resp_message": "",
"auth_id_code": "",
"txn_id": "merchantId-JPAYNEW034-1"
},
"gateway_id": 23,
"upi":{
"txn_flow_type":"INTENT",
"payment_method_sub_detail":{"mode":"CREDIT_CARD"}, //Only for UPICC
"payer_vpa":"9876543210@ybl", //Optional, PG dependent
"payer_app":"phonepe://pay"
},
"gateway_reference_id": null,
"offers": []
}
```
#### Raw - UPI - Collect:
```json
{
"customer_email": "test@gmail.com",
"customer_phone": "9876543210",
"customer_id": "cst_wiqou3224",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_ce50b4861d2b4b3e9bf3r3r2rid3”,
"merchant_id": "merchantId”,
"amount": 2,
"currency": "INR",
"order_id": "JPAYNEW034",
"date_created": "2021-09-10T09:06:53Z",
"return_url": "https://api.juspay.in",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"web": "https://api.juspay.in/merchant/pay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3",
"mobile": "https://api.juspay.in/merchant/pay/ordeh_ce50b4861d2b4b3e9bf3r3r2rid3?mobile=true"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "merchantId-JPAYNEW034-1",
"payment_method_type": "UPI",
"auth_type": "",
"payment_method": "UPI",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 2,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "eulk1HvJ29o9dJ344x4f",
"txn_detail": {
"txn_id": "merchantId-JPAYNEW034-1",
"order_id": "JPAYNEW034",
"status": "CHARGED",
"error_code": null,
"net_amount": 2,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 2,
"offer_deduction_amount": null,
"gateway_id": 23,
"currency": "INR",
"express_checkout": false,
"redirect": false,
"txn_uuid": "eulk1HvJ29o9dJ344x4f",
"gateway": "RAZORPAY",
"error_message": "",
"created": "2021-09-10T09:07:10Z"
},
"payment_gateway_response": {
"resp_code": "captured",
"rrn": "868709664362",
"created": "2021-09-10T09:07:39Z",
"epg_txn_id": "pay_HvhtO3324opPPs",
"resp_message": "",
"auth_id_code": "",
"txn_id": "merchantId-JPAYNEW034-1"
},
"gateway_id": 23,
"payer_vpa": "9876543210@ybl",
"upi": {
"payer_vpa": "9876543210@ybl",
"txn_flow_type": "COLLECT"
},
"gateway_reference_id": null,
"offers": []
}
```
#### Raw - Cash on Delivery:
```json
{
"customer_email": null,
"customer_phone": null,
"customer_id": null,
"status_id": 29,
"status": "COD_INITIATED",
"id": "ordeh_9b821b4bb49a46a392ab2bf59b2f4a71",
"merchant_id": "merchant_success",
"amount": 100,
"currency": "INR",
"order_id": "1690960292",
"date_created": "2023-08-02T07:11:32Z",
"return_url": "https://google.com",
"product_id": "Shocks",
"payment_links": {
"iframe": "https://sandbox.juspay.in/orders/ordeh_9b821b4bb49a46a392ab2bf59b2f4a71/payment-page",
"web": "https://sandbox.juspay.in/orders/ordeh_9b821b4bb49a46a392ab2bf59b2f4a71/payment-page",
"mobile": "https://sandbox.juspay.in/orders/ordeh_9b821b4bb49a46a392ab2bf59b2f4a71/payment-page"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "ms-1690960292-1",
"payment_method_type": "CASH",
"auth_type": "",
"payment_method": "CASH",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 250,
"resp_code": null,
"resp_message": null,
"bank_error_code": "INITIATED",
"bank_error_message": "COD initiated successfully",
"txn_uuid": "mozi6pzobgp5GJe4YbT",
"txn_detail": {
"txn_id": "ms-1690960292-1",
"order_id": "1690960292",
"status": "COD_INITIATED",
"error_code": "INITIATED",
"net_amount": 100,
"surcharge_amount": 150,
"tax_amount": 0,
"txn_amount": 250,
"offer_deduction_amount": null,
"gateway_id": 700,
"currency": "INR",
"express_checkout": false,
"redirect": true,
"txn_uuid": "mozi6pzobgp5GJe4YbT",
"gateway": "CASH",
"error_message": "COD initiated successfully",
"created": "2023-08-02T07:11:38Z",
"txn_flow_type": "CASH_PAY"
},
"payment_gateway_response": {
"resp_code": "INITIATED",
"rrn": "NA",
"created": "2023-08-02T07:11:39Z",
"epg_txn_id": "NA",
"resp_message": "COD initiated successfully",
"auth_id_code": "NA",
"txn_id": "ms-1690960292-1"
},
"gateway_id": 700,
"metadata": {
"payment_links": {
"iframe": "https://sandbox.juspay.in/orders/ordeh_9b821b4bb49a46a392ab2bf59b2f4a71/payment-page",
"web": "https://sandbox.juspay.in/orders/ordeh_9b821b4bb49a46a392ab2bf59b2f4a71/payment-page",
"mobile": "https://sandbox.juspay.in/orders/ordeh_9b821b4bb49a46a392ab2bf59b2f4a71/payment-page"
},
"payment_page_client_id": "defaultclient"
},
"gateway_reference_id": null,
"offers": []
}
```
#### Raw - Mandate + TPV:
```json
{
"customer_email": "dummyemail@gmail.com",
"customer_phone": "9876543000",
"customer_id": "cust*****de",
"status_id": 27,
"status": "CHARGED",
"id": "ordeh_bh*****ke",
"merchant_id": "merchant_id",
"amount": 1,
"currency": "INR",
"order_id": "tpvflowtest",
"date_created": "2023-11-27T11:24:00Z",
"return_url": "https://mid.in",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/orders/ordeh_b******be/payment-page",
"web": "https://api.juspay.in/orders/ordeh_b*******be/payment-page",
"mobile": "https://api.juspay.in/orders/ordeh_b*****be/payment-page"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "mid-tpvflowtest-1",
"payment_method_type": "UPI",
"auth_type": "",
"payment_method": "COLLECT",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 1,
"mandate": {
"mandate_token": "75********9",
"mandate_status": "ACTIVE",
"mandate_id": "i6********cy",
"mandate_type": "EMANDATE",
"start_date": "1701084291",
"end_date": "2647855491",
"revokable_by_customer": true,
"block_fund": false,
"max_amount": 1000,
"frequency": "ASPRESENTED",
"amount_rule": "VARIABLE"
},
"resp_code": null,
"resp_message": null,
"bank_error_code": "00",
"bank_error_message": "Your transaction is successful",
"txn_uuid": "mo****S",
"txn_detail": {
"txn_id": "mid-tpvflowtest-1",
"order_id": "tpvflowtest",
"status": "CHARGED",
"error_code": "00",
"net_amount": 1,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 1,
"offer_deduction_amount": null,
"gateway_id": 514,
"currency": "INR",
"express_checkout": false,
"redirect": true,
"txn_uuid": "mo*******S",
"gateway": "YES_BIZ",
"error_message": "Your transaction is successful",
"txn_object_type": "TPV_EMANDATE_REGISTER",
"source_object": "MANDATE",
"source_object_id": "430400013",
"created": "2023-11-27T11:24:50Z",
"txn_flow_type": "COLLECT"
},
"payment_gateway_response": {
"resp_code": "00",
"rrn": "369779777323",
"created": "2023-11-27T11:24:51Z",
"epg_txn_id": null,
"resp_message": "Your transaction is successful",
"auth_id_code": null,
"txn_id": "AX*******1",
"gateway_response": {
"amount": "1000.00",
"gatewayReferenceId": "36*****3",
"gatewayResponseCode": "00",
"gatewayResponseMessage": "Your transaction is successful",
"gatewayResponseStatus": "success",
"merchantChannelId": "mid",
"merchantId": "mid",
"merchantRequestId": "AX*****1",
"orgMandateId": "YJ*****S",
"payeeMcc": "7322",
"payeeVpa": "mid@yespay",
"payerVpa": "your_vpa@id",
"refUrl": "https://www.juspay.com/",
"remarks": "Debit Money For UPI Autopay",
"tpvValidationStatus": "SUCCESS",
"umn": "9******i"
}
},
"gateway_id": 514,
"payer_vpa": "yourvpa@id",
"upi": {
"payer_vpa": "yourvpa@id",
"txn_flow_type": "COLLECT"
},
"metadata": {
"payment_page_sdk_payload": "{\"amount\":\"1.00\",\"orderType\":\"TPV_PAYMENT\",\"metadata.bankAccountDetails\":\"[{\\\"bank_account_number\\\":\\\"5****1\\\",\\\"bank_ifsc\\\":\\\"HDFC0000000\\\", \\\"bank_beneficiary_name\\\" : \\\"Your Name\\\"}]\",\"action\":\"paymentPage\",\"paymentFilter\":{\"allowDefaultOptions\":false,\"options\":[{\"paymentMethodType\":\"UPI\",\"enable\":true}]}}",
"payment_page_client_id": "mid",
"bank_account_details": "[{\"bank_account_number\":\"50*****1\",\"bank_ifsc\":\"HDFC0000000\", \"bank_beneficiary_name\" : \"Your Name\"}]"
},
"amount_debited": 1
}
```
#### Raw - Mandate:
```json
{
"udf9": "",
"udf8": "",
"udf7": "",
"udf6": "",
"udf5": "",
"udf4": "",
"udf3": "",
"udf2": "",
"udf10": "",
"udf1": "",
"txn_uuid": "eulmyxQn6bQso6y1Syy",
"txn_id": "juspay-234823498237423894273498-1",
"txn_detail": {
"txn_uuid": "eulmyxQn6bQso6y1Syy",
"txn_object_type": "EMANDATE_REGISTER",
"txn_id": "juspay-234823498237423894273498-1",
"txn_amount": 1,
"tax_amount": null,
"surcharge_amount": null,
"status": "CHARGED",
"source_object_id": "91887",
"source_object": "MANDATE",
"redirect": true,
"order_id": "234823498237423894273498",
"net_amount": 1,
"gateway_id": 19,
"gateway": "PAYTM_V2",
"express_checkout": false,
"error_message": "",
"error_code": "",
"currency": "INR",
"created": "2020-08-30T09:53:17Z"
},
"status_id": 21,
"status": "CHARGED",
"return_url": "https://api.juspay.in",
"refunded": false,
"product_id": "",
"payment_method_type": "UPI",
"payment_method": "UPI",
"payment_links": {
"web": "https://api.juspay.in/merchant/pay/ordeu_9a0929803da644df8036133cf14d0206",
},
"payment_gateway_response": {
"txn_id": "juspay-234823498237423894273498-1",
"rrn": "4299662",
"resp_message": "Txn Success",
"resp_code": "01",
"epg_txn_id": "202008301131312168187301880189",
"created": "2020-08-30T09:54:10Z",
"auth_id_code": ""
},
"payer_vpa": "9999999999@paytm",
"order_id": "234823498237423894273498",
"metadata": {
"PAYTM_V2:gateway_reference_id": "upimandate"
},
"merchant_id": "juspay",
"mandate": {
"start_date": "1598745600",
"rule_value": 30,
"rule_type": "AFTER",
"revokable_by_customer": true,
"max_amount": 1000,
"mandate_type": "EMANDATE",
"mandate_token": "ad1d28b13f460fb5d348487be790f3",
"mandate_status": "ACTIVE",
"mandate_id": "3XMEcS1z2212Gq7fbfVYbzj",
"frequency": "MONTHLY",
"end_date": "1606521610",
"block_fund": false,
"amount_rule": "VARIABLE"
},
"id": "ordeu_9a0929803da644df8036133cf14d0206",
"gateway_reference_id": "upimandate",
"gateway_id": 19,
"date_created": "2020-08-30T09:47:46Z",
"customer_phone": "9999999999",
"customer_id": "cst_lz7zmpemoo5okv",
"customer_email": "customer@gmail.com",
"currency": "INR",
"bank_error_message": "",
"bank_error_code": "",
"auth_type": "",
"amount_refunded": 0,
"amount": 1
}
```
#### Raw - EMI:
```json
{
"customer_email": "test@gmail.com",
"customer_phone": "9999999999",
"customer_id": "CUSTOMER",
"status_id": 21,
"status": "CHARGED",
"id": "ordeh_1894a9c3450194ff39db6e7356382d56e",
"merchant_id": "TEST",
"amount": 15122,
"currency": "INR",
"order_id": "XXXX1234",
"date_created": "2023-03-07T04:36:08Z",
"return_url": "www.google.com",
"product_id": "",
"payment_links": {
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_1894a9cb30194ff39db6e7356323456e",
"web": "https://api.juspay.in/orders/ordeh_1894a9cb30194ff39db6e7352d56e/payment-page",
"mobile": "https://api.juspay.in/orders/ordeh_1894a9cb30194ff39db6e6382d56e/payment-page"
},
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"txn_id": "",
"payment_method_type": "",
"auth_type": "THREE_DS",
"card": {
"expiry_year": "2027",
"card_reference": "token_b81625a434254134a7aa89b16915",
"saved_to_locker": true,
"expiry_month": "09",
"name_on_card": "name",
"card_issuer": "HDFC Bank",
"last_four_digits": "1111",
"using_saved_card": false,
"card_fingerprint": "77tjnlafqf9ppmf9lmj9o18",
"card_isin": "411111",
"card_type": "CREDIT",
"card_brand": "VISA",
"tokenization_user_consent": true,
"token_created": {
"card_reference": "token_b8a434254134a392d7aa89b16915",
"card_fingerprint": "77tjnlafqf9lmj9ekeo18",
"tokenization_status": "ACTIVE"
},
"using_token": false,
"token": {
"card_reference": "token_b81625a43425412d7aa89b16915",
"card_fingerprint": "77tjnlafqf9ppmf9lmeo18",
"last_four_digits": "1111",
"card_isin": "4111111",
"expiry_year": "2027",
"expiry_month": "04",
"par": "50XXXXXXXXXXXXXXXXXXXX6",
"tokenization_status": "ACTIVE"
},
"card_issuer_country": "INDIA",
"juspay_bank_code": "JP_HDFC",
"extended_card_type": "CREDIT"
},
"payment_method": "MASTERCARD",
"refunded": false,
"amount_refunded": 0,
"effective_amount": 15122,
"resp_code": null,
"resp_message": null,
"bank_error_code": "",
"bank_error_message": "",
"txn_uuid": "moztmUw6ryK1DZXwBEV",
"txn_detail": {
"txn_id": "TEST-XXXX1234-1",
"order_id": "XXXX1234",
"status": "CHARGED",
"error_code": null,
"net_amount": 15122,
"surcharge_amount": null,
"tax_amount": null,
"txn_amount": 15122,
"offer_deduction_amount": null,
"gateway_id": 12,
"currency": "INR",
"metadata": {
"microapp": "hyperpay",
"payment_channel": "MWEB"
},
"express_checkout": false,
"redirect": true,
"txn_uuid": "moztmXXXryxxxxxZXwBEV",
"gateway": "PAYU",
"error_message": "",
"created": "2023-03-07T04:36:42Z",
"txn_flow_type": "EMI"
},
"payment_gateway_response": {
"resp_code": "success",
"rrn": "202343000000000",
"created": "2023-03-07T04:37:35Z",
"epg_txn_id": "12121212121",
"resp_message": "No Error",
"auth_id_code": "00000000",
"txn_id": "TEST-XXXX1234-1"
},
"gateway_id": 12,
"emi_bank": "HDFC",
"emi_tenure": 3,
"gateway_reference_id": "HDFC",
"offers": [],
"maximum_eligible_refund_amount": 15122
}
```
#### Raw - Offers:
```json
{
"udf9": ",
"udf8": ",
"udf7": ",
"udf6": ",
"udf5": ",
"udf4": ",
"udf3": ",
"udf2": ",
"udf10": ",
"udf1": ",
"txn_uuid": "eulxs4WpmdFDSWsBWSZ",
"txn_id": "bsmast1620572051-1",
"status_id": 21,
"status": "CHARGED",
"return_url": "https://google.com",
"resp_message": null,
"resp_code": null,
"refunded": false,
"product_id": ",
"payment_method_type": "CARD",
"payment_method": "VISA",
"payment_links": {
"web": "https://api.juspay.in/merchant/pay/ordeh_5er343d6a6fe4b2883ec3c6",
"mobile": "https://api.juspay.in/merchant/pay/ordeh_5eb4b9883ec3c6?mobile=true",
"iframe": "https://api.juspay.in/merchant/ipay/ordeh_5er3423b4b9883ec3c6"
},
"payment_gateway_response": {
"txn_id": "bsmast1620572051-1",
"rrn": "NA",
"resp_message": "Successful transaction.",
"resp_code": "100",
"epg_txn_id": "6205720806856300403008",
"created": "2021-05-09T14:54:41Z",
"auth_id_code": "831200"
},
"order_id": "asg1620572051",
"offers": [
{
{
"status": "AVAILED",
"offer_id": "2c8701bd-94da-4e40-b56e-4aa481cddd0f",
"offer_code": "OfferCardBase1",
"benefits": [
{
"type": "DISCOUNT",
"calculation_info": {
"value": 15,
"calculation_rule": "ABSOLUTE"
"max_amount": 1000
},
"amount": 150
}
]
}
],
"merchant_id": "test",
"id": "ordeh_5e4343d6a6fe4b2d9a23b4b9883ec3c6",
"gateway_id": 6,
"date_created": "2021-05-09T14:54:11Z",
"customer_phone": "8888888888",
"customer_id": "cst_s35j8cghim6qncud",
"customer_email": "x@something.com",
"currency": "INR",
"card": {
"using_saved_card": false,
"saved_to_locker": true,
"name_on_card": "customer surname",
"last_four_digits": "4242",
"expiry_year": "2025",
"expiry_month": "05",
"card_type": "CREDIT",
"card_reference": ",
"card_issuer": ",
"card_isin": "424242",
"card_fingerprint": ",
"card_brand": "VISA"
},
"bank_error_message": ",
"bank_error_code": ",
"auth_type": ",
"amount_refunded": 0,
"amount": 1000,
"effective_amount": 850
}
```
#### Encrypted - Response:
```json
{
"JWT": "************************************************************************************************************************************************************************************************************************************************"
}
```
## Query Parameters:
#### JWT:
Encrypted Payload
- Tags: String, Conditional
## Body Parameters:
### Encrypted Body:
#### JWT:
- Value: value
- Tags: String, Conditional
### Decrypted Request Body:
#### order_id:
- Value: Order id provided by JSUPAY at the time of Order Creation
- Tags: String, Mandatory
#### ?options.add_full_gateway_response:
- Value: To get entire Payment Gateway Response pass True
- Tags: Boolean
## API Responses:
### 200:
#### JWT:
- Value: Encrypted Response
- Tags: String, Mandatory
### 400:
#### not enough input:
- 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
### API Latency Guideline
#### **What is API Latency?**
Time taken by the server to respond to the API request.
#### **Average API Percentile Metrics and Recommended Timeout**
**TP50 (s):** This means 50% of the requests have a latency less than or equal to this value. It represents the typical latency most users will experience.
**TP90 (s):** The latency at the 90th percentile. This indicates that 90% of the requests have a latency less than or equal to this value, with 10% experiencing higher latency.
**TP99 (s):** The latency at the 99th percentile. This indicates that 99% of the requests have a latency less than or equal to this value, with 1% experiencing higher latency.
**TP99.9 (s):** The latency at the 99.9th percentile. This is important for identifying edge cases, where 0.1% of the requests take significantly longer than the others.
**TP99.99 (s):** The latency at the 99.99th percentile. This captures extremely rare cases, where just 0.01% of the requests take longer than this time. Monitoring this helps in identifying and addressing the rarest and most severe performance issues.
| Transaction Percentile | Latency (ms) |
|---|---|
| TP50 (ms) | 0.0198 |
| TP90 (ms) | 55.71 |
| TP99 (ms) | 351.85 |
| TP99.9 (ms) | 594.42 |
| Recommended Timeout | 1000 |
> **Warning**
> The recommended timeouts are based on TP99.9 data, though edge cases (0.01% of requests) may still exceed these limits and are captured in the TP99.99 data as shown below.
>
>
> | Transaction Percentile | Latency (ms) |
> |---|---|
> | TP99.99 (ms) | 1431.42 |
> | Recommended Timeout | 2000 |
>