get https://uptime.phonepe.com/v1/pg/merchants//health
The health check API gives realtime information on the health of PhonePe PG.
Description
In order to eliminate the dependency on email alerts, we would recommend you integrate Health Status API. You can consume this API and can take the necessary action basis on the responses of this API.
URL
For Prod
Host URL: https://uptime.phonepe.com
Path Parameters
Parameter | Type | Description | Mandatory |
---|---|---|---|
merchantId | String | Unique Merchant ID assigned to the merchant by PhonePe | Yes |
Request Headers
Header Name | Header Value |
---|---|
Content-Type | application/json |
X-VERIFY | SHA256("/v1/pg/merchants/{merchantId}/health" + saltKey) + "###" + saltIndex |
Sample Response
{
"overallHealth": "UP",
"instruments": {
"UPI": {
"health": "UP"
},
"CREDIT_CARD": {
"health": "UP"
},
"DEBIT_CARD": {
"health": "UP"
},
"NET_BANKING": {
"health": "UP"
}
}
}
{
"overallHealth": "UP",
"instruments": {
"NET_BANKING": {
"health": "UP"
},
"WALLET": {
"health": "UP"
},
"CREDIT_CARD": {
"health": "UP"
},
"DEBIT_CARD": {
"health": "UP"
},
"UPI": {
"health": "UP",
"downProviderIds": {
"PSP": [
"okicici"
],
"BANK": [
"KKBK"
]
}
}
}
}
{
"overallHealth": "UP",
"instruments": {
"UPI": {
"health": "UP"
},
"CREDIT_CARD": {
"health": "UP"
},
"DEBIT_CARD": {
"health": "UP"
},
"NET_BANKING": {
"health": "UP",
"downProviderIds": {
"BANK": [
"HDFC",
"KKBK"
]
}
}
}
}
Response Parameters
Parameter Name | Type | Description/validations |
---|---|---|
overallHealth | Enum | The overall health of the PhonePe PG (across all instruments). Values include [UP, DOWN] |
instruments | Map | Map of health for each instrument type: ‘UPI’, ‘DEBIT_CARD’ and ‘CREDIT_CARD’, NET_BANKING |
instrument.health | Enum | Health of the instrument. [UP, DOWN] |
downProviderIds | Map of ProviderType -> list of ids | Further detailed information on specific providers (banks, etc.) that are down. Provider Types: ● BANK ● CARD_NETWORK ● PSP |
Health Types
Health Type | Description |
---|---|
UP | Success rates are normal |
DOWN | Success rates are critically low |
Error Codes
Code | Description |
---|---|
BAD_REQUEST | Invalid request |
AUTHORIZATION_FAILED | Invalid X-VERIFY header |
INTERNAL_SERVER_ERROR | Something went wrong |