Check Order Status

Environment

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

Request

Request Headers

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

Path Parameters

Parameter Name	Description
`merchantOrderId`	The unique merchant order ID provided by the merchant when creating the subscription

Response

Sample Debit Card Transaction Response

{
    "merchantId": "TX12345",
    "merchantOrderId": "MO1774243061089",
    "orderId": "OMO2603231047412984235557BW",
    "state": "PENDING",
    "currency": "INR",
    "amount": 200,
    "expireAt": 1774243961270,
    "metaInfo": {
        "udf1": "udf1",
        "udf2": "udf2"
    },
    "paymentFlow": {
        "type": "SUBSCRIPTION_SETUP",
        "merchantSubscriptionId": "MS1774243061089",
        "authWorkflowType": "ZERO",
        "amountType": "FIXED",
        "maxAmount": 20000000,
        "frequency": "MONTHLY",
        "expireAt": 1774643045000,
        "subscriptionId": "OMS2603231047412704235838BW",
        "productType": "ENACH_MANDATE",
        "authInstrumentType": "DEBIT_CARD"
    },
    "paymentDetails": []
}

Sample NetBanking Transaction Response

{
    "merchantId": "TX12345",
    "merchantOrderId": "MO1774243061089",
    "orderId": "OMO2603231047412984235557BW",
    "state": "PENDING",
    "currency": "INR",
    "amount": 200,
    "expireAt": 1774243961270,
    "metaInfo": {
        "udf1": "udf1",
        "udf2": "udf2"
    },
    "paymentFlow": {
        "type": "SUBSCRIPTION_SETUP",
        "merchantSubscriptionId": "MS1774243061089",
        "authWorkflowType": "ZERO",
        "amountType": "FIXED",
        "maxAmount": 20000000,
        "frequency": "MONTHLY",
        "expireAt": 1774643045000,
        "subscriptionId": "OMS2603231047412704235838BW",
        "productType": "ENACH_MANDATE",
        "authInstrumentType": "NET_BANKING"
    },
    "paymentDetails": []
}

Response Parameter

Parameter Name	Data Type	Mandatory	Description
`merchantId`	String	Yes	Merchant identifier
`merchantOrderId`	String	Yes	Merchant’s unique identifier for the setup order
`orderId`	String	Yes	PG generated internal order ID for the setup
`state`	String	Yes	Final state of the setup order (e.g., COMPLETED, PENDING, FAILED)
`currency`	String	Yes	Currency code (e.g., INR)
`amount`	Long	Yes	Initial setup order amount in paisa
`expireAt`	Long	Yes	Order expiry timestamp in epoch
`metaInfo.udf1`	String	No	User Defined Field 1
`metaInfo.udf2`	String	No	User Defined Field 2
`paymentFlow.type`	String	Yes	Type of flow (e.g., SUBSCRIPTION_SETUP)
`paymentFlow.merchantSubscriptionId`	String	Yes	Merchant’s unique identifier for the subscription
`paymentFlow.authWorkflowType`	String	Yes	Authentication method (e.g., ZERO)
`paymentFlow.amountType`	String	Yes	Type of recurring charge (e.g., VARIABLE or FIXED)
`paymentFlow.maxAmount`	Long	Yes	Maximum limit for recurring debits in paisa
`paymentFlow.frequency`	String	Yes	Frequency of debit (e.g., DAILY, MONTHLY)
`paymentFlow.expireAt`	Long	Yes	Mandate expiry timestamp in epoch
`paymentFlow.subscriptionId`	String	Yes	PG internal ID for the subscription
`paymentFlow.productType`	String	Yes	Instrument category (e.g., ENACH_MANDATE)
`paymentFlow.authInstrumentType`	String	Yes	Auth channel used (e.g., NET_BANKING/DEBIT_CARD)
`paymentDetails`	List	No	Contains list of details of each payment attempt (empty if no direct payment attempt was required for ZERO auth)