Auth Request Status
get https://api-preprod.phonepe.com/apis/pg-sandbox/v3/recurring/auth/status/{merchantId}/{authRequestId}

To check the status of the auth init request

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256(“/v3/recurring/auth/status/{merchantId}/{authRequestId}” + saltKey) + “###” + saltIndex

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePeYes
authRequestIdSTRINGAuth Request Id for which status is to be fetchedYes

Sample Response for TRANSACTION Type

Sample Response
{ "success": true, "code": "SUCCESS", "message": "Your subscription is created.", "data": { "merchantId": "MID12345", "authRequestId": "TX123456789", "subscriptionDetails": { "subscriptionId": "OMS2006110139450123456789", "state": "CREATED" } } }
Sample Response - Transaction - ACTIVE State
{ "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", "ifsc": "HDFC0000999", "maskedAccountNumber": "XXXXXX999", "umn": "9123dac357de123cb2cbd45283412305@ybl" } ] }, "subscriptionDetails": { "subscriptionId": "OMS2006110139450123456789", "state": "ACTIVE" } } }
Sample Response - Transaction - FAILED State
{ "success": true, "code": "SUCCESS", "message": "Your subscription is failed.", "data": { "merchantId": "MID12345", "authRequestId": "TX123456789", "transactionDetails": { "providerReferenceId": "P1806151323093900554957", "amount": 39900, "state": "FAILED", "payResponseCode": "Z9", "payResponseCodeDescription": "Insufficient Funds", "paymentModes": [ { "mode": "ACCOUNT", "amount": 399000, "utr": "816626521616" } ] }, "subscriptionDetails": { "subscriptionId": "OMS2006110139450123456789", "state": "FAILED" } } }

Sample Response for PENNY DROP Type

Sample Response - PENNY DROP - CREATED State
{ "success": true, "code": "SUCCESS", "message": "Your subscription is created.", "data": { "merchantId": "MID12345", "authRequestId": "TX123456789", "subscriptionDetails": { "subscriptionId": "OMS2006110139450123456789", "state": "CREATED" } } }
Sample Response - PENNY DROP - ACTIVE State
{ "success": true, "code": "SUCCESS", "message": "Your subscription is active.", "data": { "merchantId": "MID12345", "authRequestId": "TX123456789", "subscriptionDetails": { "subscriptionId": "OMS2006110139450123456789", "state": "ACTIVE" } } }
Sample Response - PENNY DROP - FAILED State
{ "success": true, "code": "SUCCESS", "message": "Your subscription is failed.", "data": { "merchantId": "MID12345", "authRequestId": "TX123456789", "subscriptionDetails": { "subscriptionId": "OMS2006110139450123456789", "state": "FAILED" } } }

Response Parameters

Field NameData TypeDescriptionComments
merchantIdSTRINGMID provided by PhonePe
subscriptionIdSTRINGUser’s unique Id maintained by merchant
authRequestIdSTRINGMerchant’s auth request Id
transactionDetailsOBJECTSame as normal Transaction, please
refer here
● Available when subscription
authWorkflowType is
TRANSACTION and not in
PENNY_DROP
transactionDetails.payResponseCodeSTRINGPhonePe 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.payResponseCodeDescriptionSTRINGDescription of the payResponseCode
● Max Length – 256
● Optional Parameter
subscriptionDetailsOBJECTContains subscriptionId and state● As available previously in this
document.
{“method”:”get”,”url”:”/v3/recurring/auth/status/{merchantId}/{authRequestId}”,”auth”:”required”,”results”:{“codes”:[{“name”:””,”code”:”{}”,”language”:”json”,”status”:200},{“name”:””,”code”:”{}”,”language”:”json”,”status”:400}]},”params”:[{“name”:”merchantId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Unique Merchant ID assigned to the merchant by PhonePe”,”required”:false,”in”:”path”,”ref”:””,”_id”:”60ae1177347cb9000f396cc2″},{“name”:”authRequestId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Auth Request Id for which status is to be fetched”,”required”:false,”in”:”path”,”ref”:””,”_id”:”60ae1177347cb9000f396cc1″},{“name”:”Content-Type”,”type”:”string”,”enumValues”:””,”default”:”application/json”,”desc”:””,”required”:true,”in”:”header”,”ref”:””,”_id”:”60ae1177347cb9000f396cc0″},{“name”:”X-VERIFY”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”SHA256(\”/v3/recurring/auth/status/{merchantId}/{authRequestId}\” + saltKey) + \”###\” + saltIndex”,”required”:true,”in”:”header”,”ref”:””,”_id”:”60ae1177347cb9000f396cbf”}],”apiSetting”:”63bb01b11abcf7046d98754c”,”examples”:{“codes”:[]}}
https://api-preprod.phonepe.com/apis/pg-sandbox

HEADERS
merchantId string
Unique Merchant ID assigned to the merchant by PhonePe
authRequestId string
Auth Request Id for which status is to be fetched
Content-Type string required
X-VERIFY string required
SHA256("/v3/recurring/auth/status/{merchantId}/{authRequestId}" + saltKey) + "###" + saltIndex

RESPONSES