Recurring Debit Execute Status

To check the status of recurring debit execute API call.

Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256("/v3/recurring/debit/status/{merchantId}/{merchantTransactionId}" + salt key) + ### + salt index

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdStringUnique Merchant ID assigned to the merchant by PhonePeYes
merchantTransactionIdStringMerchant Transaction Id for which status is to be fetchedYes
{
  "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"
        }
      ]
    },
    "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"
    },
    "subscriptionDetails": {
      "subscriptionId": "OMS2006110139450123456789",
      "state": "FAILED"
    }
  }
}

Response Parameters

Field NameData TypeDescription
merchantIdStringMerchant ID provided by PhonePe
transactionIdStringMerchant’s TransactionId
notificationDetailsObjectContains notification details
transactionDetailsObjectSame as normal Transaction, please refer here
subscriptionDetailsObjectContains subscriptionId and state
Language
Click Try It! to start a request and see the response here!