| |
|---|
Content-Type | application/json |
X-VERIFY | SHA256("/v3/auth/{merchantId}/{transactionId}/status" + saltKey) + "###" + saltIndex |
| Parameter | Type | Description | Mandatory |
|---|
merchantId | String | Unique Merchant ID assigned to the merchant by PhonePe | Yes |
transactionId | String | The transaction Id sent by merchant in the authorize request | Yes |
{
"success": true,
"code": "SUCCESS",
"message": "Your request has been successfully completed.",
"data": {
"transactionId": "TX123456789",
"authState": "AUTHORIZED",
"authorizedAmount": 9900,
"capturedAmount": 0,
"providerReferenceId": null
}
}
| Field Name | Data Type | Description | Comments |
|---|
transactionId | String | The transaction Id sent by merchant in the authorize request | |
authState | String | 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. |
authorizedAmount | Long | authorized transaction amount in Paise | |
capturedAmount | Long | Capture transaction amount in Paise | 0 if not captured |
providerReferenceId | String | 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.
| Code | Description |
|---|
SUCCESS | Your request has been successfully completed. |
BAD_REQUEST | Invalid request payload |
AUTHORIZATION_FAILED | Value of X-VERIFY is incorrect |
INTERNAL_SERVER_ERROR | Something went wrong. Please call status and try again. |
TRANSACTION_NOT_FOUND | No Authorization found with the given details. |
USER_BLACKLISTED | Customer is blacklisted on PhonePe side |
USER_DOESNOT_EXIST | Invalid user |
