PhonePe Healthcheck

The health check API gives realtime information on the health of PhonePe payment systems and reports the downtimes, if any. In order to eliminate the dependency on the email alerts, we would recommend you to integrate Health Check API.

The Health Check API will post the performance status of the merchant ID for the last 10 minutes from the time when API is called. The matrices are shared at two levels i.e Overall ecosystem of merchant and individual payment instrument basis on the thresholds configured for the merchant ID.

You can consume this API and can take the necessary action basis on the responses of this API

Path Parameters

ParameterTypeDescriptionMandatory
merchantIdStringUnique Merchant ID assigned to the merchant by PhonePeYes
transactionIdStringUnique Transaction ID generated by the merchant.Yes

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256("/v1/merchants/{merchantId}/{transactionId}/health" + saltKey) + "###" + saltIndex

Sample Response

{
  "message": "PhonePe is experiencing fluctuations in payments through UPI",
  "overallHealth": "UP",
  "instruments": [
    {
      "instrument": "WALLET",
      "health": "UP",
      "providers": []
    },
    {
      "instrument": "UPI",
      "health": "DEGRADED",
      "providers": [
        {
          "providerType": "BANK",
          "providerId": "UTIB",
          "providerName": "Axis bank",
          "health": "DOWN",
          "reason": "Low success rates"
        }      
]
    },
    {
      "instrument": "CREDIT_CARD",
      "health": "UP",
      "providers": []
    },
    {
      "instrument": "DEBIT_CARD",
      "health": "UP",
      "providers": []
    }
  ]
}

Response Parameters

Parameter NameTypeDescription / validations
overallHealthEnumOverall health of PhonePe (across all instruments).
messageStringText summary of PhonePe payment’s health
instrumentEnumMode through which payment is done, namely ‘WALLET’, ‘UPI’, ‘DEBIT_CARD’ and ‘CREDIT_CARD’
instrument.healthEnumHealth of a particular instrument
providersFurther 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 TypeDescription
UPSuccess rates are normal
DEGRADEDThere are some fluctuations in success rates
DOWNSuccess rates are critically low

Error Codes

CodeDescription
BAD_REQUESTInvalid request
AUTHORIZATION_FAILEDInvalid X-VERIFY header
INTERNAL_SERVER_ERRORSomething went wrong
Language
Click Try It! to start a request and see the response here!