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>'
import requests

url = "https://sandbox.cashfree.com/pg/incident/{id}"

headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>'
}
};

fetch('https://sandbox.cashfree.com/pg/incident/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/pg/incident/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sandbox.cashfree.com/pg/incident/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("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>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/pg/incident/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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
    }
  }
}
{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}
{
"message": "something is not found",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "something_not_found",
"type": "invalid_request_error"
}
{
"message": "internal Server Error",
"help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "internal_error",
"type": "api_error"
}

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.

Path Parameters

id
string
required

The unique identifier of the downtime.

Response

Success response for fetching a downtime 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
UPI Incident Ā· object

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

Example:
{
"upi": {
"upi_issuer": ["ALL_BANKS"],
"upi_psp": ["ALL_PSP"],
"upi_vpa": ["ybl"],
"is_npci_downtime": false
}
}