Webhooks

Webhooks are server callbacks to your server from Cashfree. Webhooks are event-based and are sent when specific events related to the transaction happen.

Cashfree sends the following webhooks for Payment Gateway:

Payment Success
Incident Services

Incident Services

Cashfree 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 sends an email alert when an issuer is facing downtime or a scheduled incident. Webhooks - Cashfree will invoke a server to server call whenever an incident is created. You can use this webhook and update your payment page accordingly.

Webhook Schema

Sample payload for creating of Incident

{
    "data": {
        "incident": {
            "end_time": null,
            "id": "INCIDENT_MEDIUM_KarurVysyaBank_a7259c79-25a8-4b86-bcab-71562a85c386",
            "impact": "MEDIUM",
            "message": "We are facing issues with KVB bank UPI payments. ",
            "start_time": "2021-04-16T14:00:00+05:30",
            "status": "OPEN",
            "type": "UNSCHEDULED"
        },
        "instruments": {
            "upi": {
                "issuers": [
                "Karur Vysya Bank"
                ]
            }
        }
    },
    "event_time": "2021-04-16T14:10:36+05:30",
    "type": "HEALTH_ALERT",
    "version": 1
}

Sample Payload when Incident is Resolved

{
  "data": {
    "incident": {
      "end_time": "2021-04-16T18:20:24+05:30",
      "id": "INCIDENT_MEDIUM_KarurVysyaBank_a7259c79-25a8-4b86-bcab-71562a85c386",
      "impact": "MEDIUM",
      "message": "Payment mode up",
      "start_time": "2021-04-16T14:00:00+05:30",
      "status": "RESOLVED",
      "type": "UNSCHEDULED"
    },
    "instruments": {
      "upi": {
        "issuers": [
          "Karur Vysya Bank"
        ]
      }
    }
  },
  "event_time": "2021-04-16T18:20:24+05:30",
  "type": "HEALTH_ALERT",
  "version": 1
}

Payload

Field	Description	Example	Mandatory
end_time	Null when an incident is created. Or end time when incident is resolved	2021-04-16T15:10:36+05:30	N
start_time	Time since we have seen this incident	2021-04-16T14:10:36+05:30	Y
id	Incident id	Alphanumeric with special characters - _,-,	Y
impact	Impact of the downtime	HIGH, MEDIUM, LOW	Y
message	Human readable message		N
status	Status 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, RESOLVED	Y
type	Is this a scheduled or an unscheduled downtime?	SCHEDULED, UNSCHEDULED	Y
instruments	Refers to the payment mode. This will contain a nested object. One of the following - upi, net_banking, card, wallet		Y
upi.issuers	Issuers which are impacted	Array	N
net_banking.issuers	Net banking banks which are impacted	Array	N
wallet.issuers	Wallets which are impacted	Array	N
card.type	Card types which are impacted	CREDIT_CARD, DEBIT_CARD, ALL	N
card.scheme	Card schemes which are impacted	MASTER, VISA, RUPAY, MAESTRO, AMEX, ALL	N
card.issuers	Banks which are impacted	Array	N
event_time	Time when this webhook was created		Y
type	Type of webhook	HEALTH_ALTER	Y
version	Version of webhook	You should build your parsing logic wrt to this version.	Y

Children	Optional	Type	Possible Values
wallet	Y*	Child Attributes	Available Below
net_banking	Y*	Child Attributes	Available Below
upi	Y*	Child Attributes	Available Below
card	Y*	Child Attributes	Available Below

At least one of the children needs to be present

Wallet

Children	Optional	Type	Possible Values
issuers	N	Text	See list of wallet issuers below.

Net Banking

Children	Optional	Type	Possible Values
issuers	N	Array	See list issuers below.

UPI

Children	Optional	Type	Possible Values
issuers	N	Array	See list of issuers below.

Card

Children	Optional	Type	Possible Values
type	N	Text	CREDIT_CARD, DEBIT_CARD, ALL
schema	N	Text	MASTER, VISA, RUPAY, MAESTRO, AMEX, ALL
issuers	N	Array	See list of issuers below.

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

Wallet Names

Name of the wallet
FreeCharge
MobiKwik
Ola Money
Reliance Jio Money
Airtel Money
Paytm
Amazon Pay
PhonePe

PAYMENT GATEWAY APIS

NEW PAYMENT GATEWAY APIS