The healthcheck API gives realtime information on health of PhonePe payment systems and reports the downtimes, if any.

Path Parameters

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

Request Headers

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

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

BAD_REQUESTInvalid request
INTERNAL_SERVER_ERRORSomething went wrong
Click Try It! to start a request and see the response here!