Redeem Order Status


EnvironmentHTTP MethodAPI
SandboxPOSThttps://api-preprod.phonepe.com/apis/pg-sandbox/subscriptions/v2/order/{{merchantOrderId}}/status
ProductionPOSThttps://api.phonepe.com/apis/pg/subscriptions/v2/order/{{merchantOrderId}}/status
Header NameHeader ValueDescription
Content-Typeapplication/json
AuthorizationO-Bearer <access_token>Pass access_token received in Authorization call
Sample Response
{
    "merchantId": "TXMT8788",
    "merchantOrderId": "MO1722319560997",
    "orderId": "OMO2601282154473535900531",
    "state": "COMPLETED",
    "currency": "INR",
    "amount": 200,
    "expireAt": 1769618686824,
    "paymentFlow": {
        "type": "SUBSCRIPTION_REDEMPTION",
        "merchantSubscriptionId": "MS1769569283073",
        "redemptionRetryStrategy": null,
        "autoDebit": false,
        "validAfter": null,
        "validUpto": null,
        "notifiedAt": null
    },
    "paymentDetails": [
        {
            "transactionId": "OM2601282154486455900694",
            "paymentMode": "ENACH_ACCOUNT",
            "timestamp": 1769617488702,
            "currency": "INR",
            "amount": 200,
            "payableCurrency": "INR",
            "payableAmount": 200,
            "feeCurrency": "INR",
            "feeAmount": 0,
            "state": "COMPLETED",
            "instrument": {
                "type": "ACCOUNT",
                "accountType": "SAVINGS",
                "bankId": "HDFC"
            },
            "rail": {
                "type": "NACH",
                "utr": "ddf5d315-93cd-4019-9137-7bb2ad2ec702"
            },
            "splitInstruments": [
                {
                    "instrument": {
                        "type": "ACCOUNT",
                        "accountType": "SAVINGS",
                        "bankId": "HDFC"
                    },
                    "rail": {
                        "type": "NACH",
                        "utr": "ddf5d315-93cd-4019-9137-7bb2ad2ec702"
                    },
                    "currency": "INR",
                    "amount": 200
                }
            ]
        }
    ]
}
Response Parameters
Parameter NameData TypeDescription
merchantIdStringMerchant identifier
merchantOrderIdStringMerchant’s unique reference for the debit attempt
orderIdStringPG internal order ID for the redemption
stateStringFinal status of debit (e.g., COMPLETED, FAILED)
currencyStringCurrency code (e.g., INR)
amountLongAmount in paisa
expireAtLongOrder expiry timestamp in epoch
paymentFlow.typeStringFlow type (e.g., SUBSCRIPTION_REDEMPTION)
paymentFlow.merchantSubscriptionIdStringThe ID of the mandate
paymentFlow.redemptionRetryStrategyString/NullStrategy for retrying failed debits
paymentFlow.autoDebitBooleanIndicates if the debit was system-triggered
paymentFlow.validAfterLong/NullValidity start timestamp
paymentFlow.validUptoLong/NullValidity end timestamp
paymentFlow.notifiedAtLong/NullTimestamp when user was notified of debit
paymentDetails[].transactionIdStringInternal transaction ID
paymentDetails[].paymentModeStringMode used (e.g., ENACH_ACCOUNT)
paymentDetails[].timestampLongTransaction attempt timestamp
paymentDetails[].currencyStringTransaction currency
paymentDetails[].amountLongTransaction amount
paymentDetails[].payableCurrencyStringCurrency payable to merchant
paymentDetails[].payableAmountLongAmount payable to merchant
paymentDetails[].feeCurrencyStringFee currency
paymentDetails[].feeAmountLongFee amount charged
paymentDetails[].stateStringTransaction state (e.g., COMPLETED)
paymentDetails[].instrument.typeStringInstrument type (e.g., ACCOUNT)
paymentDetails[].instrument.accountTypeStringAccount type (e.g., SAVINGS)
paymentDetails[].instrument.bankIdStringBank identifier (e.g., HDFC)
paymentDetails[].rail.typeStringRail type (e.g., NACH)
paymentDetails[].rail.utrStringBank Reference Number (UTR) for the transaction
paymentDetails[].splitInstruments[].instrument.typeStringSplit instrument type
paymentDetails[].splitInstruments[].instrument.accountTypeStringSplit account type
paymentDetails[].splitInstruments[].instrument.bankIdStringSplit bank identifier
paymentDetails[].splitInstruments[].rail.typeStringSplit rail type
paymentDetails[].splitInstruments[].rail.utrStringSplit UTR
paymentDetails[].splitInstruments[].currencyStringSplit currency
paymentDetails[].splitInstruments[].amountLongSplit amount
Is this article helpful?