PhonePe Health Status API

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

{“method”:”get”,”url”:”/v1/pg/merchants/{merchantId}/health”,”auth”:”never”,”results”:{“codes”:[{“status”:200,”language”:”json”,”code”:”{\n \”overallHealth\”: \”UP\”,\n \”instruments\”: {\n \”UPI\”: {\n \”health\”: \”UP\”\n },\n \”CREDIT_CARD\”: {\n \”health\”: \”UP\”\n },\n \”DEBIT_CARD\”: {\n \”health\”: \”UP\”\n },\n \”NET_BANKING\”: {\n \”health\”: \”UP\”\n }\n }\n}\n”,”name”:””}]},”examples”:{“codes”:[]},”apiSetting”:”5c372ea67267aa42020e54ba”,”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/pg/merchants/{merchantId}/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