Auth Request Status

To check the status of the auth init request

Request Headers

Header Name

Header Value

Content-Type

application/json

X-VERIFY

SHA256("/v3/recurring/auth/status/{merchantId}/{authRequestId}" + saltKey) + "###" + saltIndex

Path Parameters

Parameter Name

Type

Description

Mandatory

merchantId

STRING

Unique Merchant ID assigned to the merchant by PhonePe

Yes

authRequestId

STRING

Auth Request Id for which status is to be fetched

Yes

{
  "success": true,
  "code": "SUCCESS",
  "message": "Your subscription is created.",
  "data": {
    "merchantId": "MID12345",
    "authRequestId": "TX123456789",
    "subscriptionDetails": {
      "subscriptionId": "OMS2006110139450123456789",
      "state": "CREATED"
    }
  }
}
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your subscription is active.",
  "data": {
    "merchantId": "MID12345",
    "authRequestId": "TX123456789",
    "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": "Your subscription is failed.",
  "data": {
    "merchantId": "MID12345",
    "authRequestId": "TX123456789",
    "transactionDetails": {
      "providerReferenceId": "P1806151323093900554957",
      "amount": 39900,
      "state": "FAILED",
      "payResponseCode": "AUTHORIZATION_FAILED",
      "paymentModes": [
        {
          "mode": "ACCOUNT",
          "amount": 399000,
          "utr": "816626521616"
        }
      ]
    },
    "subscriptionDetails": {
      "subscriptionId": "OMS2006110139450123456789",
      "state": "FAILED"
    }
  }
}
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your subscription is created.",
  "data": {
    "merchantId": "MID12345",
    "authRequestId": "TX123456789",
    "subscriptionDetails": {
      "subscriptionId": "OMS2006110139450123456789",
      "state": "CREATED"
    }
  }
}
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your subscription is active.",
  "data": {
    "merchantId": "MID12345",
    "authRequestId": "TX123456789",
    "subscriptionDetails": {
      "subscriptionId": "OMS2006110139450123456789",
      "state": "ACTIVE"
    }
  }
}
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your subscription is failed.",
  "data": {
    "merchantId": "MID12345",
    "authRequestId": "TX123456789",
    "subscriptionDetails": {
      "subscriptionId": "OMS2006110139450123456789",
      "state": "FAILED"
    }
  }
}

Response Parameters

Field Name

Data Type

Description

Comments

merchantId

STRING

MID provided by PhonePe

subscriptionId

STRING

User's unique Id maintained by merchant

authRequestId

STRING

Merchant's auth request Id

transactionDetails

OBJECT

Same as normal Transaction, please
refer here

● Available when subscription
authWorkflowType is
TRANSACTION and not in
PENNY_DROP

subscriptionDetails

OBJECT

Contains subscriptionId and state

● As available previously in this
document.

Language
Click Try It! to start a request and see the response here!