Check Order Status

This API lets you check the real-time status of a payment using the merchant order ID. It is used when the Webhook response is not received. This helps you confirm whether the payment was successful, failed, or still in pending.

Environment

Environment	HTTP Method	API
Sandbox	`GET`	https://api-preprod.phonepe.com/apis/pg-sandbox/checkout/v2/order/{merchantOrderId}/status
Production	`GET`	https://api.phonepe.com/apis/pg/checkout/v2/order/{merchantOrderId}/status

Request

Request Headers

Header Name	Header Value
Content-Type	application/json
Authorization	O-Bearer <merchant-auth-token>

📘 Query Parameters for Order Status Endpoint

The following endpoint is used for both UAT and Production:
/checkout/v2/order/{merchantOrderId}/status?details=false&errorContext=true
The query parameters details and errorContext are optional.
By default, both are set to false.

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

Query the API with above details using HTTP GET method, below is the sample CURL for the same:

Sample Request

curl --location 'https://api-preprod.phonepe.com/apis/pg-sandbox/checkout/v2/order/TX123rrty34432456/status?details=false' \
--header 'Content-Type: application/json' \
--header 'Authorization: O-Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHBpcmVzT24iOjE3MTIyNTM2MjU2NDQs

Response

Sample Response

{
  "orderId": "OMO2403282020198641071317",
  "state": "COMPLETED",
  "amount": 1000,
  "expireAt": 1711867462542,
  "paymentDetails": [
    {
      "paymentMode": "UPI_QR",
      "transactionId": "OM2403282020198651071949",
      "timestamp": 1711694662542,
      "amount": 1000,
      "state": "COMPLETED",
      "rail": {
        "type": "UPI",
        "utr": "<utr>",
        "upiTransactionId": "<upiTransactionId>",
        "vpa": "<vpa>"
      },
      "instrument": {
        "type": "ACCOUNT",
        "maskedAccountNumber": "<maskedAccountNumber>",
        "accountType": "SAVINGS",
        "accountHolderName": "<accountHolderName>"
      }
    }
  ]
}

Case 1: Response for Order is completed and details = true

{
  "orderId": "OMO2407021511185686967711",
  "state": "COMPLETED",
  "amount": 1000,
  "payableAmount": 1000,
  "feeAmount": 0,
  "expireAt": 1719913878566,
  "metaInfo": {
    "udf1": "",
    "udf2": "",
    "udf3": "",
    "udf4": "",
    "udf5": "",
    "udf6": "",
    "udf7": "",
    "udf8": "",
    "udf9": "",
    "udf10": "",
    "udf11": "",
    "udf12": "",
    "udf13": "",
    "udf14": "",
    "udf15": ""
  },
  "paymentDetails": [
    {
      "transactionId": "OM2407021515097451914211",
      "paymentMode": "UPI_INTENT",
      "timestamp": 1719913509762,
      "amount": 1000,
      "payableAmount": 1000,
      "feeAmount": 0,
      "state": "COMPLETED",
      "rail": {
        "type": "UPI",
        "upiTransactionId": "upi12313",
        "vpa": "12****78@ybl"
      },
      "instrument": {
        "type": "ACCOUNT",
        "maskedAccountNumber": "XXXXXX5533",
        "accountType": "SAVINGS"
      },
      "splitInstruments": [
        {
          "instrument": {
            "type": "ACCOUNT",
            "maskedAccountNumber": "XXXXXX5533",
            "accountType": "SAVINGS"
          },
          "rail": {
            "type": "UPI",
            "utr": "455069731511",
            "upiTransactionId": "YBL369f6d962de74c2680789bff8c11aec9",
            "vpa": "12****78@ybl"
          },
          "amount": 1000
        }
      ]
    }
  ]
}

Case 2: Response for PPE_INTENT split payment case

{
  "orderId": "OMO2407111823257502858511",
  "state": "COMPLETED",
  "amount": 200,
  "payableAmount": 200,
  "feeAmount": 0,
  "expireAt": 1720703005748,
  "metaInfo": {
    "udf1": "",
    "udf2": "",
    "udf3": "",
    "udf4": "",
    "udf5": "",
    "udf6": "",
    "udf7": "",
    "udf8": "",
    "udf9": "",
    "udf10": "",
    "udf11": "",
    "udf12": "",
    "udf13": "",
    "udf14": "",
    "udf15": ""
  },
  "paymentDetails": [
    {
      "transactionId": "OM2407111823340281302812",
      "paymentMode": "UPI_INTENT",
      "timestamp": 1720702414053,
      "amount": 200,
      "payableAmount": 200,
      "feeAmount": 0,
      "state": "COMPLETED",
      "splitInstruments": [
        {
          "instrument": {
            "type": "ACCOUNT",
            "maskedAccountNumber": "XXXXXX6862",
            "accountType": "SAVINGS"
          },
          "rail": {
            "type": "UPI",
            "utr": "455948340054",
            "upiTransactionId": "YBLec33d3d277264fd8ac5deeabfece2494",
            "vpa": "12****78@ybl"
          },
          "amount": 100
        },
        {
          "instrument": {
            "type": "WALLET"
          },
          "rail": {
            "type": "PPI_WALLET"
          },
          "amount": 100
        }
      ]
    }
  ]
}

Case 3: Response for No payment attempt is made for order

{
    "orderId": "OMO2407111821482103732111",
    "state": "PENDING",
    "amount": 100,
    "expireAt": 1720702908208,
    "metaInfo": {
        "udf1": "<additional-information-1>",
        "udf2": "<additional-information-2>",
        "udf3": "<additional-information-3>",
        "udf4": "<additional-information-4>",
        "udf5": "<additional-information-5>",
        "udf6": "<additional-information-6>",
        "udf7": "<additional-information-7>",
        "udf8": "<additional-information-8>",
        "udf9": "<additional-information-9>",
        "udf10": "<additional-information-10>",
        "udf11": "<additional-information-11>",
        "udf12": "<additional-information-12>",
        "udf13": "<additional-information-13>",
        "udf14": "<additional-information-14>",
        "udf15": "<additional-information-15>"
    },
    "paymentDetails": []
}

Case 4: Response for Order is Failed

{
  "orderId": "OMO2407121214395503786511",
  "state": "FAILED",
  "amount": 200,
  "expireAt": 1720767279548,
  "errorCode": "INVALID_MPIN",
  "detailedErrorCode": "ZM",
  "metaInfo": {
    "udf1": "<additional-information-1>",
    "udf2": "<additional-information-2>",
    "udf3": "<additional-information-3>",
    "udf4": "<additional-information-4>",
    "udf5": "<additional-information-5>",
    "udf6": "<additional-information-6>",
    "udf7": "<additional-information-7>",
    "udf8": "<additional-information-8>",
    "udf9": "<additional-information-9>",
    "udf10": "<additional-information-10>",
    "udf11": "<additional-information-11>",
    "udf12": "<additional-information-12>",
    "udf13": "<additional-information-13>",
    "udf14": "<additional-information-14>",
    "udf15": "<additional-information-15>"
  },
  "paymentDetails": [
    {
      "transactionId": "OM2407121214579231302711",
      "paymentMode": "UPI_COLLECT",
      "timestamp": 1720766697944,
      "amount": 200,
      "payableAmount": 200,
      "feeAmount": 0,
      "state": "FAILED",
      "errorCode": "INVALID_MPIN",
      "detailedErrorCode": "ZM"
    }
  ],
  "errorContext": {
    "errorCode": "INVALID_MPIN",
    "detailedErrorCode": "ZM",
    "source": "CUSTOMER",
    "stage": "AUTHENTICATION",
    "description": "Wrong MPIN was entered"
  }
}

Case 5: Response for Invalid order ID

{
  "success": false,
  "code": "MERCHANT_ORDER_MAPPING_NOT_FOUND",
  "message": "No entry found for <Merchant Order Id>",
  "data": {}
}

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
`amount`	String	Order amount in paisa
`expireAt`	Long	Order expiry time in epoch
`metaInfo`	Object	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 object 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 • TOKEN • 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`	String	Contains processing rail details under which payment attempt is made
`paymentDetails.instrument`	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]

Run a Sample Order Status Check!

headers

url params

What’s Next?

After checking the status of an order, you may need to handle post-payment actions like issuing a refund, especially for failed, cancelled, or customer returned transactions.

Head over to the next section to learn how to process refunds.