Recurring Debit Execute Status

To check the status of recurring debit execute API call.

Headers

Header Name	Header Value
`Content-Type`	application/json
`X-VERIFY`	SHA256(“/v3/recurring/debit/status/{merchantId}/{merchantTransactionId}” + salt key) + ### + salt index

Path Parameters

Parameter Name	Type	Description	Mandatory
`merchantId`	String	Unique Merchant ID assigned to the merchant by PhonePe	Yes
`merchantTransactionId`	String	Merchant Transaction Id for which status is to be fetched	Yes

{
    "success": true,
    "code": "SUCCESS",
    "message": "Your payment is successful.",
    "data": {
        "merchantId": "MID12345",
        "transactionId": "TX1234567890",
        "notificationDetails": {
            "notificationId": "OMN2006110139450123456789",
            "amount": 39900,
            "state": "NOTIFIED",
            "notifiedAt": 1622539751586,
            "validAfter": 1622539750000,
            "validUpto": 1622885350000
        },
        "transactionDetails": {
            "providerReferenceId": "P1806151323093900554957",
            "amount": 39900,
            "state": "COMPLETED",
            "payResponseCode": "SUCCESS",
            "paymentModes": [
                {
                    "mode": "ACCOUNT",
                    "amount": 399000,
                    "utr": "816626521616",
                    "maskedAccountNumber": "XXXXXX999",
                    "umn": "9123dac357de123cb2cbd45283412305@ybl"
                }
            ]
        },
        "subscriptionDetails": {
            "subscriptionId": "OMS2006110139450123456789",
            "state": "ACTIVE"
        }
    }
}

{
    "success": true,
    "code": "SUCCESS",
    "message": "Payment Failed",
    "data": {
        "merchantId": "MID12345",
        "transactionId": "TX1234567890",
        "notificationDetails": {
            "notificationId": "OMN2006110139450123456789",
            "amount": 39900,
            "state": "NOTIFIED",
            "notifiedAt": 1622539751586,
            "validAfter": 1622539750000,
            "validUpto": 1622885350000
        },
        "transactionDetails": {
            "providerReferenceId": "P1806151323093900554957",
            "amount": 39900,
            "state": "FAILED",
            "payResponseCode": "AUTHORIZATION_FAILED",
            "payResponseCodeDescription": "Bank did not authorise"
        },
        "subscriptionDetails": {
            "subscriptionId": "OMS2006110139450123456789",
            "state": "ACTIVE"
        }
    }
}

Response Parameters

Parameter Name	Type	Description
`merchantId`	String	Merchant ID provided by PhonePe
`transactionId`	String	Merchant’s TransactionId
`notificationDetails`	Object	Contains notification details
`transactionDetails`	Object	Same as normal Transaction
`transactionDetails.payResponseCode`	String	PhonePe internal status code. Please note this is a string value and new codes are likely to be added in the future. (Please don’t do the marshaling/unmarshalling into an enum for this at your side). This is an informative value.
`transactionDetails.payResponseCodeDescription`	String	Description of the payResponseCode ● Max Length – 256 ● Optional Parameter
`subscriptionDetails`	Object	Contains subscriptionId and state

Headers

Path Parameters

Response Parameters

Updated on Aug 11, 2023