Check Auth Status

Get the authorization status of a given transaction. Should be called in case auth API returns code INTERNAL_SERVER_ERROR.

Request Headers

Content-Typeapplication/json
X-VERIFYSHA256("/v3/auth/{merchantId}/{transactionId}/status" + saltKey) + "###" + saltIndex

Path Parameters

ParameterTypeDescriptionMandatory
merchantIdStringUnique Merchant ID assigned to the merchant by PhonePeYes
transactionIdStringThe transaction Id sent by merchant in the authorize requestYes
{
  "success": true,
  "code": "SUCCESS",
  "message": "Your request has been successfully completed.",
  "data": {
    "transactionId": "TX123456789",
    "authState": "AUTHORIZED",
    "authorizedAmount": 9900,
    "capturedAmount": 0,
    "providerReferenceId": null
    }
}

Response Parameters

Field NameData TypeDescriptionComments
transactionIdStringThe transaction Id sent by merchant in the authorize request
authStateStringCurrent state of the auth & capture transaction. For details, check the authState flow diagram below.Capture should be called only after the state is AUTHORIZED. Call auth status api if it is not.
authorizedAmountLongauthorized transaction amount in Paise
capturedAmountLongCapture transaction amount in Paise0 if not captured
providerReferenceIdStringPhonePe ReferenceId for an initiated Payment

🚧

Note

  • Do not use this API for validating the transaction state for fulfillment.
  • An authState=COMPLETED does not guarantee transaction completion.
  • The transaction status API must be called before fulfilling an order.

Other Response Codes

CodeDescription
SUCCESSYour request has been successfully completed.
BAD_REQUESTInvalid request payload
AUTHORIZATION_FAILEDValue of X-VERIFY is incorrect
INTERNAL_SERVER_ERRORSomething went wrong. Please call status and try again.
TRANSACTION_NOT_FOUNDNo Authorization found with the given details.
USER_BLACKLISTEDCustomer is blacklisted on PhonePe side
USER_DOESNOT_EXISTInvalid user
Language
Click Try It! to start a request and see the response here!