Notification Status

This API helps you check the status of a notify redemption for an active subscription. After the notify redemption is triggered, you can use this API to track its progress. It shows whether the customer has been notified, if the process is still in progress, or if it has been completed.

API Endpoint

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>

Path Parameters

Parameter Name	Description
`merchantOrderId`	Merchant-generated order ID that was shared during the Redemption Notify API call.

Sample Request in CURL

curl --location 'https://api-preprod.phonepe.com/apis/pg-sandbox/subscriptions/v2/order/MO1709025691805/status?details=true' \
--header 'Accept: application/json' \
--header 'Authorization: O-Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHBpcmVzT24iOjE3MTIyNTM2MjU2NDQsIm1lcmNoYW50SWQiOiJWMlNVQlVBVCJ9.7aVzYI_f_77-bBicEcRNuYx093b2wCsgl_WFNkKqAPY'

Response

Sample Response

{
  "orderId": "OMO2604141043461445825945V",
  "state": "NOTIFIED",
  "currency": "INR",
  "amount": 100,
  "expireAt": 1776489226123,
  "paymentFlow": {
    "type": "SUBSCRIPTION_CHECKOUT_REDEMPTION",
    "merchantSubscriptionId": "Sub123",
    "redemptionRetryStrategy": "STANDARD",
    "autoDebit": false,
    "validAfter": 1776230026000,
    "validUpto": 1776489226000,
    "notifiedAt": 1776143626555
  },
  "paymentDetails": []
}

Response Parameters

Parameter Name	Data Type	Description
`merchantId`	String	Unique transaction ID generated by PhonePe Payment Gateway.
`merchantOrderId`	String	A unique orderId provided by the merchant when creating the order.
`orderId`	String	Unique order ID generated by PhonePe Payment Gateway.
`state`	String	Final state of the order Possible value: • NOTIFICATION_IN_PROGRESS • NOTIFIED
`amount`	Long	The amount provided by the merchant in Paise.
`expireAt`	DateTime	Represents the time in epoch (milliseconds).
`paymentFlow`	Array	Provides the details of the subscription.
`paymentFlow.type`	String	The type should be “SUBSCRIPTION_REDEMPTION“ for redemption-related actions.
`paymentFlow.merchantSubscriptionId`	String	A unique subscriptionId provided by the merchant to identify and manage the subscription request.
`paymentFlow.retryStrategy`	String	STANDARD
`paymentFlow.maxAmount`	Boolean	If true, PhonePe will handle the execution process.
`paymentFlow.validAfter`	DateTime	The start timestamp of the redemption window, provided in milliseconds.
`paymentFlow.autoDebit`	Boolean	If set to true, Indicates whether the redemption is processed automatically.
`paymentFlow.validAfter`	DateTime	Start time (in milliseconds) of the redemption window.
`paymentFlow.validUpto`	DateTime	End time (in milliseconds) of the redemption window.
`paymentFlow.notifiedAt`	DateTime	Timestamp (in milliseconds) when the customer was notified about the redemption.
`paymentDetails`	DateTime	The timestamp in milliseconds indicating when the customer was notified about the scheduled redemption.