Order Status API
The Order Status API enables you to check the current status of a specific order by providing its order ID. It returns information indicating whether the order has been successfully completed with payment details, is part of a split payment using PPE_INTENT, has no payment attempts yet, or if the payment has failed. Additionally, it handles cases where the provided order ID is invalid. This helps you reliably track and manage the order and take necessary actions based on its status.
Environment
| Environment | HTTP Method | API |
| Sandbox | GET | https://api-preprod.phonepe.com/apis/pg-sandbox/payments/v2/order/{merchantOrderId}/status |
| Production | GET | https://api.phonepe.com/apis/pg/payments/v2/order/{merchantOrderId}/status |
Request
Request Headers
| Header Name | Header Value |
| Content-Type | application/json |
| Authorization | O-Bearer <merchant-auth-token> |
⚠️ For Partner Integrations!
It is mandatory to include the X-MERCHANT-ID header with the MerchantID of the end merchant.
Request Parameters
| Parameter Name | Description |
details | • true → return all attempt details under paymentDetails list • false → return only latest attempt details under paymentDetails list |
errorContext | • true → To receive the errorContext block with error details if the state is FAILED. • false → If the errorContext block is not required. |
merchantOrderId | Order ID created in a Payment request. |
Response
Case 1: Sample Response for Rupay CC
{
"orderId": "OMO2604271746073357212779V",
"state": "COMPLETED",
"currency": "INR",
"amount": 500,
"payableCurrency": "INR",
"payableAmount": 500,
"feeCurrency": "INR",
"feeAmount": 0,
"expireAt": 1777293367335,
"paymentDetails": [
{
"transactionId": "OM2604271746087619516629V",
"paymentMode": "UPI_QR",
"timestamp": 1777292168794,
"currency": "INR",
"amount": 505,
"payableCurrency": "INR",
"payableAmount": 505,
"feeCurrency": "INR",
"feeAmount": 0,
"state": "COMPLETED",
"instrument": {
"type": "ACCOUNT",
"maskedAccountNumber": "652926XXXXXXXX75",
"ifsc": "HDCC0000001",
"accountHolderName": "Kumar",
"accountType": "CREDIT",
"cardNetwork": "RUPAY",
"bankId": "HDCC",
"networkCardVariant": "RUPAY_SELECT",
"cardBin": "652926"
},
"rail": {
"type": "UPI",
"utr": "916369838423",
"upiTransactionId": "YBL7f3dc5d4f9b842c88e71bf1a794f6d8d",
"vpa": "83XXXXXXXX-2@ybl"
},
"splitInstruments": [
{
"instrument": {
"type": "ACCOUNT",
"maskedAccountNumber": "652926XXXXXXXX75",
"ifsc": "HDCC0000001",
"accountHolderName": "Kumar",
"accountType": "CREDIT",
"cardNetwork": "RUPAY",
"bankId": "HDCC",
"networkCardVariant": "RUPAY_SELECT",
"cardBin": "652926"
},
"rail": {
"type": "UPI",
"utr": "916369838423",
"upiTransactionId": "YBL7f3dc5d4f9b842c88e71bf1a794f6d8d",
"vpa": "83XXXXXXXX-2@ybl"
},
"currency": "INR",
"amount": 505
}
],
"phonepeTPAPTxnDetailsLink": "https://phon.pe/7kg0h8ye"
}
],
"phonepeTPAPTxnDetailsLink": "https://phon.pe/7kg0h8ye"
}Case 2: Sample Response for Order completed
{
"orderId": "OMO2603311414039364883780V",
"state": "COMPLETED",
"currency": "INR",
"amount": 500,
"payableCurrency": "INR",
"payableAmount": 500,
"feeCurrency": "INR",
"feeAmount": 0,
"expireAt": 1774947843929,
"paymentDetails": [
{
"transactionId": "OM2603311414039474883144V",
"paymentMode": "UPI_QR",
"timestamp": 1774946643975,
"currency": "INR",
"amount": 500,
"payableCurrency": "INR",
"payableAmount": 500,
"feeCurrency": "INR",
"feeAmount": 0,
"state": "COMPLETED",
"instrument": {
"type": "ACCOUNT",
"maskedAccountNumber": "XXXXXX0426",
"ifsc": "BARB0VJYELA",
"accountType": "SAVINGS",
"bankId": "BARB"
},
"rail": {
"type": "UPI",
"utr": "727206606755",
"upiTransactionId": "YBL57f35fe764b1468daa682227ae0262da"
},
"splitInstruments": [
{
"instrument": {
"type": "ACCOUNT",
"maskedAccountNumber": "XXXXXX0426",
"ifsc": "BARB0VJYELA",
"accountType": "SAVINGS",
"bankId": "BARB"
},
"rail": {
"type": "UPI",
"utr": "727206606755",
"upiTransactionId": "YBL57f35fe764b1468daa682227ae0262da"
},
"currency": "INR",
"amount": 500
}
],
"phonepeTPAPTxnDetailsLink": "https://phon.pe/p57ptqcr"
}
],
"settlementDetails": {
"state": "NOT_INITIATED"
},
"phonepeTPAPTxnDetailsLink": "https://phon.pe/p57ptqcr"
}Case 3: Sample Response for Order failed
{
"orderId": "OMO2407121214395503786511",
"state": "FAILED",
"amount": 200,
"expireAt": 1720767279548,
"errorCode": "INVALID_MPIN", // Only present if the state is FAILED
"detailedErrorCode": "ZM", // Only present if the state is FAILED
"metaInfo": {
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"udf11": "",
"udf12": "",
"udf13": "",
"udf14": "",
"udf15": ""
},
"paymentDetails": [
{
"transactionId": "OM2407121214579231302711",
"paymentMode": "UPI_COLLECT",
"timestamp": 1720766697944,
"amount": 200,
"payableAmount": 200,
"feeAmount": 0,
"state": "FAILED",
"errorCode": "INVALID_MPIN", // Only present if the state is FAILED
"detailedErrorCode": "ZM" // Only present if the state is FAILED
}
],
"errorContext": { // Only present if the state is FAILED
"errorCode" : "INVALID_MPIN",
"detailedErrorCode" : "ZM",
"source" : "CUSTOMER",
"stage" : "AUTHENTICATION",
"description" : "Wrong MPIN was entered"
}
}Case 4: Response for Payment Mode: CARD
{
"orderId": "OMO2507241148405311106438",
"state": "COMPLETED",
"amount": 100,
"payableAmount": 100,
"feeAmount": 0,
"expireAt": 1753338820531,
"metaInfo":
{
"udf1": "Sharma",
"udf2": "30",
"udf3": "UDF3",
"udf4": "UDF4",
"udf5": "UDF5",
"udf6": "UDF6"
"udf7": "UDF7",
"udf8": "UDF8",
"udf9": "UDF9",
"udf10": "UDF10",
"udf11": "UDF11",
"udf12": "UDF12",
"udf13": "UDF13",
"udf14": "UDF14",
"udf15": "UDF15"
},
"paymentDetails":
[
{
"transactionId": "OM2507241150264011152620",
"paymentMode": "CARD",
"timestamp": 1753338026421,
"amount": 100,
"payableAmount": 100,
"feeAmount": 0,
"state": "COMPLETED",
"instrument":
{
"type": "CREDIT_CARD",
"bankId": "HDFC",
"brn": "520506406845",
"geoScope": "DOMESTIC",
"cardNetwork": "VISA",
"maskedCardNumber": "******1234"
},
"rail":
{
"type": "PG",
"authorizationCode": "088005"
},
"splitInstruments":
[
{
"instrument":
{
"type": "CREDIT_CARD",
"bankId": "HDFC",
"brn": "520506406845",
"geoScope": "DOMESTIC",
"cardNetwork": "VISA",
"maskedCardNumber": "******1234"
},
"rail":
{
"type": "PG",
"authorizationCode": "088005"
},
"amount": 100
}
]
}
]
}Case 5: No payment attempt is made for the order
{
"orderId": "OMOxx",
"state": "CREATED",
"amount": 10000,
"expireAt": 1720767279548,
"metaInfo": {
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"udf6": "",
"udf7": "",
"udf8": "",
"udf9": "",
"udf10": "",
"udf11": "",
"udf12": "",
"udf13": "",
"udf14": "",
"udf15": ""
}
}Case 6: Invalid Order ID
{
"success": false,
"code": "ORDER_NOT_FOUND",
"message": "No entry found for <MID>, <merchantOrderId>",
"data": {}
}Case 7: Response for CREDIT_LINE
{
"merchantId": "MERCHANT123",
"merchantOrderId": "ORD123456",
"orderId": "OID789",
"state": "COMPLETED",
"amount": 50000,
"currency": "INR",
"payableAmount": 50000,
"payableCurrency": "INR",
"feeAmount": 0,
"feeCurrency": "INR",
"discountAmount": 0,
"expireAt": 1746000000000,
"metaInfo": {
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": ""
},
"paymentDetails": [
{
"transactionId": "TXN789",
"paymentMode": "CREDIT_LINE",
"timestamp": 1746000000000,
"amount": 50000,
"currency": "INR",
"payableAmount": 50000,
"payableCurrency": "INR",
"feeAmount": 0,
"feeCurrency": "INR",
"state": "COMPLETED",
"instrument": {
"type": "CREDIT_LINE",
"ifsc": "ICIC0001234",
"accountHolderName": "John Doe",
"bankId": "ICICI",
"maskedAccountNumber": "XXXXXX1234",
"unmaskedAccountNumber": "1234567890",
"providerAccountType": "CL01"
},
"rail": {
"type": "UPI",
"utr": "UTR123456789",
"vpa": "user@bankhandle",
"upiTransactionId": "UPI123456"
}
}
],
"paymentFlow": {
"type": "PG"
}
}Case 8: Response for WALLET
{
"event": "checkout.order.completed",
"payload": {
"merchantId": "XXXXXX",
"merchantOrderId": "XXXXXX",
"orderId": "OMO2603261223225462835636V",
"state": "COMPLETED",
"currency": "INR",
"amount": 100,
"payableCurrency": "INR",
"payableAmount": 100,
"feeCurrency": "INR",
"feeAmount": 0,
"expireAt": 1774511902527,
"paymentDetails": [
{
"transactionId": "OMO2603261223225462835636V",
"paymentMode": "PPE_QR",
"timestamp": 1774508013985,
"currency": "INR",
"amount": 100,
"payableCurrency": "INR",
"payableAmount": 100,
"feeCurrency": "INR",
"feeAmount": 0,
"state": "COMPLETED",
"instrument": {
"type": "WALLET"
},
"rail": {
"type": "PPI_WALLET"
},
"splitInstruments": [
{
"instrument": {
"type": "WALLET"
},
"rail": {
"type": "PPI_WALLET"
},
"currency": "INR",
"amount": 100
}
]
}
}Case 9: paymentMode.type = “CARD” for EMI
{
"merchantId": "MER277",
"merchantOrderId": "f620c33caa95ca4878a9144aa8eaeabbadf",
"orderId": "OMO2607081628479232700022V",
"state": "COMPLETED",
"currency": "INR",
"amount": 100,
"payableCurrency": "INR",
"payableAmount": 100,
"feeCurrency": "INR",
"feeAmount": 0,
"expireAt": 1783509227924,
"paymentDetails": [
{
"transactionId": "OM2607081628482907923729V",
"paymentMode": "CARD",
"timestamp": 1783508328367,
"currency": "INR",
"amount": 100,
"payableCurrency": "INR",
"payableAmount": 100,
"feeCurrency": "INR",
"feeAmount": 0,
"state": "COMPLETED",
"instrument": {
"type": "CREDIT_CARD",
"bankId": "ICIC",
"arn": "74056636190618908412164",
"brn": "618910836322",
"geoScope": "DOMESTIC",
"cardNetwork": "VISA",
"tokenBin": "407918280",
"cardVariant": "CONSUMER",
"emiDetails": {
"type": "BANK",
"tenureInMonths": 9,
"interestPercentagePerAnnum": 16.0
}
},
"rail": {
"type": "PG",
"authorizationCode": "200799"
},
"splitInstruments": [
{
"instrument": {
"type": "CREDIT_CARD",
"bankId": "ICIC",
"arn": "74056636190618908412164",
"brn": "618910836322",
"geoScope": "DOMESTIC",
"cardNetwork": "VISA",
"tokenBin": "407918280",
"cardVariant": "CONSUMER",
"emiDetails": {
"type": "BANK",
"tenureInMonths": 9,
"interestPercentagePerAnnum": 16.0
}
},
"rail": {
"type": "PG",
"authorizationCode": "200799"
},
"currency": "INR",
"amount": 100
}
],
"phonepeTPAPTxnDetailsLink": "https://phon.pe/x1movc7x"
}
],
"phonepeTPAPTxnDetailsLink": "https://phon.pe/x1movc7x"
}Case 10: paymentMode.type = “TOKEN” for EMI
{
"merchantId": "MER123",
"merchantOrderId": "OD1786536180424",
"orderId": "OMO2608121733077682820565BW",
"state": "COMPLETED",
"currency": "INR",
"amount": 380000,
"payableCurrency": "INR",
"payableAmount": 380000,
"feeCurrency": "INR",
"feeAmount": 0,
"expireAt": 1786536907226,
"metaInfo": {
"udf1": "<additional-information-1>",
"udf2": "<additional-information-2>",
"udf3": "<additional-information-3>",
"udf4": "<additional-information-4>"
},
"paymentDetails": [
{
"transactionId": "OM2608121733083572820657BW",
"paymentMode": "TOKEN",
"timestamp": 1786536188955,
"currency": "INR",
"amount": 380000,
"payableCurrency": "INR",
"payableAmount": 380000,
"feeCurrency": "INR",
"feeAmount": 0,
"state": "COMPLETED",
"instrument": {
"type": "CREDIT_CARD",
"bankId": "HDFC",
"brn": "RRN178653619397612",
"geoScope": "DOMESTIC",
"maskedCardNumber": "XXXXXXXXXXXX9197",
"cardNetwork": "VISA",
"tokenBin": "420858123",
"cardHolderName": "GUEST_MERCHANT_TOKEN",
"cardVariant": "DEFAULT",
"emiDetails": {
"type": "BANK",
"tenureInMonths": 6,
"interestPercentagePerAnnum": 16.0,
"subventionAmount": 0
}
},
"rail": {
"type": "PG",
"authorizationCode": "9362177348"
},
"splitInstruments": [
{
"instrument": {
"type": "CREDIT_CARD",
"bankId": "HDFC",
"brn": "RRN178653619397612",
"geoScope": "DOMESTIC",
"maskedCardNumber": "XXXXXXXXXXXX9197",
"cardNetwork": "VISA",
"tokenBin": "420858123",
"cardHolderName": "GUEST_MERCHANT_TOKEN",
"cardVariant": "DEFAULT",
"emiDetails": {
"type": "BANK",
"tenureInMonths": 6,
"interestPercentagePerAnnum": 16.0,
"subventionAmount": 0
}
},
"rail": {
"type": "PG",
"authorizationCode": "9362177348"
},
"currency": "INR",
"amount": 380000
}
]
}
]
} Case 11: paymentMode.type = “ALT_ID” for EMI
{
"merchantId": "MER1057",
"merchantOrderId": "OD1786536180424",
"orderId": "OMO2608121733077682820565BW",
"state": "COMPLETED",
"currency": "INR",
"amount": 380000,
"payableCurrency": "INR",
"payableAmount": 380000,
"feeCurrency": "INR",
"feeAmount": 0,
"expireAt": 1786536907226,
"metaInfo": {
"udf1": "<additional-information-1>",
"udf2": "<additional-information-2>",
"udf3": "<additional-information-3>",
"udf4": "<additional-information-4>"
},
"paymentDetails": [
{
"transactionId": "OM2608121733083572820657BW",
"paymentMode": "ALT_ID",
"timestamp": 1786536188955,
"currency": "INR",
"amount": 380000,
"payableCurrency": "INR",
"payableAmount": 380000,
"feeCurrency": "INR",
"feeAmount": 0,
"state": "COMPLETED",
"instrument": {
"type": "CREDIT_CARD",
"bankId": "HDFC",
"brn": "RRN178653619397612",
"geoScope": "DOMESTIC",
"maskedCardNumber": "XXXXXXXXXXXX9197",
"cardNetwork": "VISA",
"tokenBin": "420858123",
"cardHolderName": "GUEST_MERCHANT_TOKEN",
"cardVariant": "DEFAULT",
"emiDetails": {
"type": "BANK",
"tenureInMonths": 6,
"interestPercentagePerAnnum": 16.0,
"subventionAmount": 0
}
},
"rail": {
"type": "PG",
"authorizationCode": "9362177348"
},
"splitInstruments": [
{
"instrument": {
"type": "CREDIT_CARD",
"bankId": "HDFC",
"brn": "RRN178653619397612",
"geoScope": "DOMESTIC",
"maskedCardNumber": "XXXXXXXXXXXX9197",
"cardNetwork": "VISA",
"tokenBin": "420858123",
"cardHolderName": "GUEST_MERCHANT_TOKEN",
"cardVariant": "DEFAULT",
"emiDetails": {
"type": "BANK",
"tenureInMonths": 6,
"interestPercentagePerAnnum": 16.0,
"subventionAmount": 0
}
},
"rail": {
"type": "PG",
"authorizationCode": "9362177348"
},
"currency": "INR",
"amount": 380000
}
]
}
]
}Response Parameters
| Field Name | Data Type | Description |
orderId | String | Payment Gateway generated internal order ID |
state | String | State of order, Expected Values = [PENDING, FAILED, COMPLETED]Note: Merchants should rely only on the root level “state” parameter for the Payment status confirmation. |
amount | String | Order amount in paisa |
expireAt | Long | Order expiry time in epoch |
metaInfo | Object | Merchant-defined meta information passed at the time of order creation |
paymentDetails | List | Contains a list of details of each payment attempt made corresponding to this order |
The metaInfo object contains additional parameters, which are explained in the table below.
Request Parameters of metoInfo Object:
| Parameter Name | Data Type | Description | Mandatory (Yes/No) | Constraints |
metaInfo.udf1-15 | String | Optional details you can add for more information | No | • Maximum length for Udf1-10 = 256 characters • Maximum length for Udf11-15 = 50 characters |
The paymentDetails list contains additional parameters, which are explained in the table below.
Request Parameters of paymentDetails Object:
| Field Name | Data Type | Description |
paymentDetails[*].paymentMode | String | Mode of payment; Expected Values: • UPI_INTENT • UPI_COLLECT • UPI_QR • CARD • NET_BANKING |
paymentDetails[*].timestamp | Long | Transaction attempt timestamp in epoch |
paymentDetails[*].amount | Long | Amount in paisa, corresponding to payment attempt |
paymentDetails[*].transactionId | String | Internal transaction ID for given payment attempt |
paymentDetails[*].state | String | Transaction attempt state; Expected Values: • PENDING • COMPLETED • FAILED |
paymentDetails[*].errorCode | String | Error code (Only present when the transaction state is failed) |
paymentDetails[*].detailedErrorCode | String | Detailed Error Code (Only present when the transaction state is failed) |
paymentDetails[*].rail | Object | Contains processing rail details under which payment attempt is made |
paymentDetails[*].rail.type | String | Type of rail. Expected values: • UPI • PG |
paymentDetails[*].instrument | Object | Contains instrument details |
paymentDetails[*].instrument.type | String | Type of payment instrument; Expected values: • ACCOUNT • CREDIT_CARD • DEBIT_CARD • NET_BANKING |
Rail and Instrument Values for Each Payment Mode
Rail = “UPI”, When payment Mode = [UPI_INTENT, UPI_COLLECT, UPI_QR]
"rail": {
"type": "UPI",
"utr": "<utr>",
"upiTransactionId": "upi12313",
"vpa": "12****78@ybl"
}Rail = “PG”, When payment Mode = [CARD, TOKEN, NET_BANKING]
"rail": {
"type": "PG",
"transactionId": "<transactionId>",
"authorizationCode": "<authorizationCode>",
"serviceTransactionId": "<serviceTransactionId>"
}Instrument = “ACCOUNT”, When payment Mode = [UPI_INTENT, UPI_COLLECT, UPI_QR]
"instrument": {
"type": "ACCOUNT",
"accountType": "SAVINGS",
"maskedAccountNumber": "<maskedAccountNumber>",
"accountHolderName": "<accountHolderName>"
}Instrument = “CREDIT_CARD”, When payment Mode = [CARD, UPI_INTENT, UPI_COLLECT, UPI_QR]
"instrument": {
"type": "CREDIT_CARD",
"bankTransactionId": "<bankTransactionId>",
"bankId": "<bankId>",
"arn": "<arn>",
"brn": "<brn>"
}Instrument = “DEBIT_CARD”, When payment Mode = [CARD]
"instrument": {
"type": "DEBIT_CARD",
"bankTransactionId": "<bankTransactionId>",
"bankId": "<bankId>",
"arn": "<arn>",
"brn": "<brn>"
}Instrument = “NET_BANKING”, When payment Mode = [NET_BANKING]
"instrument": {
"type": "NET_BANKING",
"bankTransactionId": "<bankTransactionId>",
"bankId": "<bankId>",
"arn": "<arn>",
"brn": "<brn>"
}Try it yourself!
headers
url params