Health Check Webhook

The Health Check Webhook gives realtime information on the health of PhonePe PG.

Description

Copied !

In order to eliminate the dependency on email alerts, we would recommend you to subscribe to the Health Check Webhook.

IMPORTANT:

• It is to be noted that callbacks can be missed and the merchant should also keep polling the Health Check API call in some intervals to update the state in such cases.

• The timestamp is sent in the webhook response so that the merchant can always keep the latest callback to avoid cases where there is a change in the order in which the merchant received the callback. The rest of the payload is same as the Health Check API.
  Note: timestamp will be a epoch timestamp ( in milliseconds)

Webhook Response Details

Case 1: When health is UP at all level.

{
  "payload": {
    "overallHealth": "UP",
    "instruments": {
      "NET_BANKING": {
        "health": "UP"
      },
      "WALLET": {
        "health": "UP"
      },
      "CREDIT_CARD": {
        "health": "UP"
      },
      "DEBIT_CARD": {
        "health": "UP"
      },
      "UPI": {
        "health": "UP"
      }
    }
  },
  "timestamp": 1716285941449
}

Case 2: Kill switch is active on UPI

{
  "payload": {
    "overallHealth": "UP",
    "instruments": {
      "NET_BANKING": {
        "health": "UP"
      },
      "WALLET": {
        "health": "UP"
      },
      "CREDIT_CARD": {
        "health": "UP"
      },
      "DEBIT_CARD": {
        "health": "UP"
      },
      "UPI": {
        "health": "UP"
      }
    }
  },
  "timestamp": 1716285941449
}

Case 3: Kill switch is active on PG flow.

{
  "payload": {
    "overallHealth": "DOWN"
  },
  "timestamp": 1716285941449
}

Case 4: Kill switch is active for bank provider SBI, HDFC and PSP okicici with instrument UPI

{
  "payload": {
    "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": [
            "SBI",
            "HDFC"
          ]
        }
      }
    }
  },
  "timestamp": 1716285941449
}

Case 5: Low success rate but not below DOWN_THRESHOLD SBI with net banking instrument.

{
  "payload": {
    "overallHealth": "UP",
    "instruments": {
      "NET_BANKING": {
        "health": "UP",
        "degradedProviderIds": {
          "BANK": [
            "SBI"
          ]
        }
      },
      "WALLET": {
        "health": "UP"
      },
      "CREDIT_CARD": {
        "health": "UP"
      },
      "DEBIT_CARD": {
        "health": "UP"
      },
      "UPI": {
        "health": "UP"
      }
    }
  },
  "timestamp": 1716285941449
}