Skip to main content
GET
/
incident
/
{id}
Fetch downtime by Id
curl --request GET \
  --url https://sandbox.cashfree.com/pg/incident/{id} \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "incident_id": "incident_20240415091057099071",
  "incident_impact": "MEDIUM",
  "incident_message": "Some UPI transactions are failing due to intermittent issues with NPCI.",
  "incident_start_time": "2025-04-15T08:00:00Z",
  "incident_end_time": "2025-04-16T08:00:00Z",
  "incident_status": "ACTIVE",
  "incident_type": "SCHEDULED",
  "payment_method": {
    "upi": {
      "upi_issuer": [
        "ALL_BANKS"
      ],
      "upi_psp": [
        "ALL_PSP"
      ],
      "upi_vpa": [
        "ybl"
      ],
      "is_npci_downtime": false
    }
  }
}

Authorizations

x-client-id
string
header
required

Client app ID. You can find your app id in the merchant dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the merchant dashboard.

Headers

x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD.

Path Parameters

id
string
required

The unique identifier of the downtime.

Response

OK

Response returned when fetching incident details by ID.

incident_id
string

Unique identifier for the incident.

Example:

"incident_20240415091057099071"

incident_impact
enum<string>

Impact level of the incident.

Available options:
HIGH,
MEDIUM,
LOW
Example:

"MEDIUM"

incident_message
string

Description of the issue.

Example:

"Some UPI transactions are failing due to intermittent issues with NPCI."

incident_start_time
string<date-time>

Start time of the incident.

Example:

"2025-04-15T08:00:00Z"

incident_end_time
string<date-time> | null

End time of the incident, if applicable; null if still ongoing.

Example:

"2025-04-16T08:00:00Z"

incident_status
enum<string>

Current status of the incident.

Available options:
ACTIVE,
UPCOMING,
RESOLVED
Example:

"ACTIVE"

incident_type
string

Type of the incident.

Example:

"SCHEDULED"

payment_method
object

The UPI incident object will show details about the incident affecting UPI payments.

  • UPI Incident
  • Card Incident
  • NetBanking Incident
  • Wallet incident
Example:
{
"upi": {
"upi_issuer": ["ALL_BANKS"],
"upi_psp": ["ALL_PSP"],
"upi_vpa": ["ybl"],
"is_npci_downtime": false
}
}