Cashfree Payments Developer Documentation

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

Query Parameters

incident_id

string

Valid incident id for fetching incident details

incident_status

enum<string>[]

Filter incidents by status. Possible values: ACTIVE, UPCOMING, RESOLVED

Available options:

ACTIVE,

UPCOMING,

RESOLVED

incident_impact

enum<string>[]

Filter incidents by impact level. Possible values: HIGH, MEDIUM, LOW

Available options:

HIGH,

MEDIUM,

LOW

incident_type

enum<string>[]

Filter incidents by type. Possible values: SCHEDULED, UNSCHEDULED

Available options:

SCHEDULED,

UNSCHEDULED

incident_start_time

string<date-time>

Filter incidents by start time. Format: YYYY-MM-DD HH:MM:SS

incident_end_time

string<date-time>

Filter incidents by end time. Format: YYYY-MM-DD HH:MM:SS

payment_method

enum<string>[]

Filter incidents by payment method. Possible values: UPI, CARD, NET_BANKING, WALLET

Available options:

UPI,

CARD,

NET_BANKING,

WALLET

Response

Success response for Fetch All Downtimes.

count

integer

Example:

4

incidents

IncidentObject · object[]

Show child attributes

incidents.incident_id

string

Unique identifier for the incident.

Example:

"incident_202434253459071"

incidents.incident_impact

enum<string>

Impact level of the incident.

Available options:

HIGH,

MEDIUM,

LOW

Example:

"HIGH"

incidents.incident_message

string

Description of the incident.

Example:

"We are facing issues with HDFC UPI transactions."

incidents.incident_start_time

string<date-time>

Start time of the incident.

Example:

"2024-06-01T14:00:00+05:30"

incidents.incident_end_time

string<date-time> | null

End time of the incident, or null if ongoing.

Example:

"2024-06-02T14:00:00+05:30"

incidents.incident_status

enum<string>

Status of the incident.

Available options:

ACTIVE,

UPCOMING,

RESOLVED

Example:

"ACTIVE"

incidents.incident_type

enum<string>

Type of the incident.

Available options:

SCHEDULED,

UNSCHEDULED

Example:

"UNSCHEDULED"

incidents.payment_method

UPI Incident · object

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

UPI Incident
Card Incident
NetBanking Incident
Wallet incident

Show child attributes

incidents.payment_method.upi

object

Show child attributes

incidents.payment_method.upi.upi_issuer

string[]

Example:

["ALL_BANKS"]

incidents.payment_method.upi.upi_psp

string[]

Example:

["ALL_PSP"]

incidents.payment_method.upi.upi_vpa

string[]

Example:

["ybl"]

incidents.payment_method.upi.is_npci_downtime

boolean

Example:

false

Example:

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

Payments API

v2025-01-01

Other Versions

Fetch All Downtimes

Authorizations

Headers

Query Parameters

Response