Create Account

# Incident Service

Cashfree Payments will notify you whenever we create an incident at our end. An incident implies that the issuing bank is facing high failure rates or has scheduled a maintenance activity during that time. The former could be due to many reasons and until the failure rates go down, we would recommend customers to use alternative payment instruments.

There are two channels through which we notify. You can subscribe to either of the channels by adding your email address and webhook endpoint in the merchant dashboard. Email - Cashfree Payments will send an email alert when an issuer is facing downtime or a scheduled incident. Webhooks - Cashfree Payments will invoke a server to server call whenever an incident is created. You can use this webhook and update your payment page accordingly.

Click [here](🔗) to know how to configure webhooks.

## Webhook Schema

**Sample Payload for Creation of Incident** 


**Sample Payload When Incident is Resolved** 

## Payload
FieldDescriptionExampleMandatory
end_timeNull when an incident is created. Or end time when incident is resolved2021-04-16T15:10:36+05:30N
start_timeTime since we have seen this incident2021-04-16T14:10:36+05:30Y
idIncident idAlphanumeric with special characters - _,-,Y
impactImpact of the downtimeHIGH, MEDIUM, LOWY
messageHuman readable message
N
statusStatus of the incident. OPEN when the incident is created. RESOLVED once the incident is resolved. UPDATE once we update the incident with any more details.OPEN, UPDATE, RESOLVEDY
typeIs this a scheduled or an unscheduled downtime?SCHEDULED, UNSCHEDULEDY
instrumentsRefers to the payment mode. This will contain a nested object. One of the following - upi, net_banking, card, wallet
Y
upi.issuersIssuers which are impactedArrayN
net_banking.issuersNet banking banks which are impactedArrayN
wallet.issuersWallets which are impactedArrayN
card.typeCard types which are impactedCREDIT_CARD, DEBIT_CARD, ALLN
card.schemeCard schemes which are impactedMASTER, VISA, RUPAY, MAESTRO, AMEX, ALLN
card.issuersBanks which are impactedArrayN
event_timeTime when this webhook was created
Y
typeType of webhookHEALTH_ALERTY
versionVersion of webhookYou should build your parsing logic wrt to this version.Y
ChildrenOptionalTypePossible Values
walletY*[Child attributes](🔗)Available below
net_bankingY*[Child attributes](🔗)Available below
upiY*[Child attributes](🔗)Available below
cardY*[Child attributes](🔗)Available below
  • At least one of the children needs to be present
### Wallet
ChildrenOptionalTypePossible Values
issuersNTextSee list of wallet issuers below.
### Net Banking
ChildrenOptionalTypePossible Values
issuersNArraySee list of issuers below.
### UPI
ChildrenOptionalTypePossible Values
issuersNArraySee list of issuers below.
### Card
ChildrenOptionalTypePossible Values
typeNTextCREDIT_CARD, DEBIT_CARD, ALL
schemeNTextMASTER, VISA, RUPAY, MAESTRO, AMEX, ALL
issuersNArraySee list of issuers below.
### Payload Headers
Cashfree Payments will send two custom headers for every webhook being invoked by our system.
NameDescriptionExample
x-cashfree-timestampTimestamp for this event. Used to generate signature1618562436364
x-cashfree-signatureCashfree Payments signature for this webhookke+K3gR8GssH9AMfJm+0+8jGIL1Mq7hOheP9w36/hL0=
## Signature Generation
The signature must be used to verify if the request has not been tampered with. To verify the signature at your end, you will need your Cashfree Payment Gateway secret key along with the payload.

## Bank Names
  • Bank Name
  • Axis Bank
  • Bank of Baroda - Retail Banking
  • Bank of India
  • Bank of Maharashtra
  • Canara Bank
  • Catholic Syrian Bank
  • Central Bank of India
  • City Union Bank
  • Deutsche Bank
  • DBS Bank Ltd
  • DCB Bank - Personal
  • Dhanlakshmi Bank
  • Federal Bank
  • HDFC Bank
  • ICICI Bank
  • IDBI Bank
  • IDFC Bank
  • Indian Bank
  • Indian Overseas Bank
  • IndusInd Bank
  • Jammu and Kashmir Bank
  • Karnataka Bank Ltd
  • Karur Vysya Bank
  • Kotak Mahindra Bank
  • Laxmi Vilas Bank - Retail Net Banking
  • Punjab & Sind Bank
  • Punjab National Bank - Retail Net Banking
  • RBL Bank
  • Saraswat Bank
  • South Indian Bank
  • Standard Chartered Bank
  • State Bank Of India
  • Tamilnad Mercantile Bank Ltd
  • UCO Bank
  • Union Bank of India
  • Yes Bank Ltd
  • Bank of Baroda - Corporate
  • Bank of India - Corporate
  • DCB Bank - Corporate
  • Lakshmi Vilas Bank - Corporate
  • Punjab National Bank - Corporate
  • State Bank of India - Corporate
  • Union Bank of India - Corporate
  • Axis Bank Corporate
  • Dhanlaxmi Bank Corporate
  • ICICI Corporate Netbanking
  • Ratnakar Corporate Banking
  • Shamrao Vithal Bank Corporate
  • Equitas Small Finance Bank
  • Yes Bank Corporate
  • Bandhan Bank- Corporate banking
  • Barclays Corporate- Corporate Banking - Corporate
  • Indian Overseas Bank Corporate
  • City Union Bank of Corporate
  • HDFC Corporate
  • Shivalik Bank
  • AU Small Finance
  • Bandhan Bank - Retail Net Banking
  • Shamrao Vitthal Co-operative Bank
  • Tamil Nadu State Co-operative Bank
All Banks (Note: This parameter will be sent when all banks are having a downtime)
## Wallet Names
  • Name of the wallet
  • FreeCharge
  • MobiKwik
  • Ola Money
  • Reliance Jio Money
  • Airtel Money
  • Paytm
  • Amazon Pay
  • PhonePe