| Parameter | Type | Description | Mandatory |
|---|
merchantId | String | Unique Merchant ID assigned to the merchant by PhonePe | Yes |
transactionId | String | Unique Transaction ID generated by the merchant. | Yes |
| Header Name | Header Value |
|---|
Content-Type | application/json |
X-VERIFY | SHA256("/v1/merchants/{merchantId}/{transactionId}/health" + saltKey) + "###" + saltIndex |
| |
| Parameter Name | Type | Description / validations | |
|---|
overallHealth | Enum | Overall health of PhonePe (across all instruments). | |
message | String | Text summary of PhonePe payment’s health | |
instrument | Enum | Mode through which payment is done, namely ‘WALLET’, ‘UPI’, ‘DEBIT_CARD’ and ‘CREDIT_CARD’ | |
instrument.health | Enum | Health of a particular instrument | |
providers | | Further detailed information on specific providers (banks, etc.) that are down.
Please note that, for simplicity, only providers with “DOWN” health will be included in the response. | |
| | | |
| Health Type | Description | |
|---|
UP | Success rates are normal | |
DEGRADED | There are some fluctuations in success rates | |
DOWN | Success rates are critically low | |
| | |
| Code | Description |
|---|
BAD_REQUEST | Invalid request |
AUTHORIZATION_FAILED | Invalid X-VERIFY header |
INTERNAL_SERVER_ERROR | Something went wrong |
| |
