| 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 Types
Enum values for overall, instrument and provider level health
| 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 |
| |
{“method”:”get”,”url”:”/v1/merchants/{merchantId}/{transactionId}/health”,”auth”:”never”,”results”:{“codes”:[{“status”:200,”language”:”json”,”code”:”{\n \”message\”: \”PhonePe is experiencing fluctuations in payments through UPI\”,\n \”overallHealth\”: \”UP\”,\n \”instruments\”: [\n {\n \”instrument\”: \”WALLET\”,\n \”health\”: \”UP\”,\n \”providers\”: []\n },\n {\n \”instrument\”: \”UPI\”,\n \”health\”: \”DEGRADED\”,\n \”providers\”: [\n {\n \”providerType\”: \”BANK\”,\n \”providerId\”: \”UTIB\”,\n \”providerName\”: \”Axis bank\”,\n \”health\”: \”DOWN\”,\n \”reason\”: \”Low success rates\”\n } \n]\n },\n {\n \”instrument\”: \”CREDIT_CARD\”,\n \”health\”: \”UP\”,\n \”providers\”: []\n },\n {\n \”instrument\”: \”DEBIT_CARD\”,\n \”health\”: \”UP\”,\n \”providers\”: []\n }\n ]\n}”,”name”:””},{“status”:500,”language”:”json”,”code”:”\n”,”name”:””}]},”examples”:{“codes”:[]},”apiSetting”:”5ecf9143b5bd210023b3b739″,”params”:[{“name”:”Content-Type”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”application/json”,”required”:true,”in”:”header”,”ref”:””,”_id”:”5c3716792f31b943d98e94c9″},{“name”:”X-VERIFY”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”SHA256(\”/v1/merchants/{merchantId}/{transactionId}/health\” + saltKey) + \”###\” + saltIndex”,”required”:true,”in”:”header”,”ref”:””,”_id”:”5c3716792f31b943d98e94c8″},{“name”:”merchantId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Unique Merchant ID assigned to the merchant by PhonePe”,”required”:false,”in”:”path”,”ref”:””,”_id”:”5c37311d3f232e42c646b289″}]}
https://uptime.phonepe.com
Search
Introduction
