Get the authorization status of a given transaction. Should be called in case auth API returns code INTERNAL_SERVER_ERROR.
Request Headers
| application/json |
|---|---|
| SHA256("/v3/auth/{merchantId}/{transactionId}/status" + saltKey) + "###" + saltIndex |
Path Parameters
Parameter | Type | Description | Mandatory |
|---|---|---|---|
|
| Unique Merchant ID assigned to the merchant by PhonePe |
|
|
| The transaction Id sent by merchant in the authorize request |
|
{
"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 Name | Data Type | Description | Comments |
|---|---|---|---|
|
| The transaction Id sent by merchant in the authorize request | |
|
| Current 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. |
|
| authorized transaction amount in Paise | |
|
| Capture transaction amount in Paise | 0 if not captured |
|
| PhonePe 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
Code | Description |
|---|---|
| Your request has been successfully completed. |
| Invalid request payload |
| Value of X-VERIFY is incorrect |
| Something went wrong. Please call status and try again. |
| No Authorization found with the given details. |
| Customer is blacklisted on PhonePe side |
| Invalid user |