Webhook Version V1

Configure Cashfree Payouts v1 webhooks to receive HTTP callbacks for transfer events, set the webhook URL in the dashboard, and verify signatures.

Webhooks are events that notify you about the payment status. All Payout integrations should establish a webhook to listen to payout events, like status changes on payments. Webhooks are HTTP callbacks that receive notification messages for events.

Webhooks help you receive automatic updates and are significant for completing the integration with Cashfree Payments. Webhooks are triggered with a request from your side, for example, when a transfer fails or when a daily report is available. Requests get processed both synchronously and asynchronously. In rare scenarios, for some payment methods, the outcome may take a longer duration to confirm. Cashfree Payments notifies you once we get updates from the bank about the payment status.

Do not go live without signature verification if you are using webhooks.

The oldest API keys, that are active, for Webhook signature verification to avoid signature mismatch errors.

Add a webhook

Follow the instructions below to configure webhooks for version 2 APIs:

1. Log in to the Payouts dashboard using your credentials.
2. Navigate to Developers > Webhooks.
3. Click Add Webhook URL in the Webhooks page.
   
4. In the Add Webhook popup, enter the following information:
   • Webhook URL: Enter the URL where you want to receive the transfer related notifications.
   • Select a webhook version: Select V1 from the dropdown menu.
5. Click Test & Add Webhook.
   

---

Webhook events

Payouts webhooks enable you to receive updates about all event-driven activities originating from your account. Below is the list of payouts webhooks:

Events	Notifications
TRANSFER_SUCCESS​	Transfer successful at the bank and account debited.
TRANSFER_FAILED	Sent whenever a transfer attempt fails.
TRANSFER_REVERSED	Transfer reversed by the beneficiary bank.
CREDIT_CONFIRMATION	Confirmation of balance credit.
​TRANSFER_ACKNOWLEDGED​	After the beneficiary bank has deposited the money it confirms the transfer.
TRANSFER_REJECTED	Transfer rejected by Cashfree Payments.
BENEFICIARY_INCIDENT	Sent whenever a beneficiary incident is created/resolved.
LOW_BALANCE_ALERT​	Payouts recharge account low balance alert.
BULK_TRANSFER_REJECTED	One of the transfers in the batch transfer file has been rejected.

TRANSFER_SUCCESS​

Sent when a transfer is attempted successfully at the bank and the beneficiary account is credited.

Parameters	Description
event	It contains the name of the event which just occurred. Value = TRANSFER_SUCCESS.
transferId	Id of the transfer passed by the merchant.
referenceId	Id of the transfer generated by Cashfree Payments.
acknowledged	The flag indicates if the beneficiary bank has acknowledged the transfer.
eventTime	Transfer initiation time.
utr	Unique transaction reference number provided by the bank.
signature	A unique string that helps distinguish that the request is genuine and initiated by Cashfree Payments.

---

What does the response parameter ‘acknowledged’ mean?

The acknowledged parameter value conveys if the beneficiary received the funds by checking its value. Ack = 1 or 0. 1 denotes the beneficiary received funds, and 0 denotes the beneficiary had not received funds.

The cash flow happens as explained below:

1. Debit: The debit of the transfers happens on the remitter account. After a successful debit, the beneficiary bank does further processing. When only the debit is successful, Ack = 0.

2. Credit: The beneficiary bank credits the fund to the account. The transfer is sent from the remitter bank to the beneficiary bank after a successful debit. When the credit to the end beneficiary is successful, Ack = 1.

To confirm the status of a payout, you need to check the acknowledged parameter value. If the value is 1, you can mark the transfer as successful. However, if the value is 0, you must either wait for the TRANSFER_ACKNOWLEDGED webhook event or use the Get Transfer Status API and confirm the acknowledged value.

---

​TRANSFER_FAILED

Sent when a transfer attempt fails.

Parameters	Description
event	It contains the name of the event which just occurred. Value = TRANSFER_FAILED.
transferId	Id of the transfer passed by the merchant
referenceId	Id of the transfer generated by Cashfree Payments.
reason	Reason for failure.
signature	A unique string that helps distinguish that the request is genuine and initiated by Cashfree Payments.

---

TRANSFER_REVERSED

Sent when the beneficiary bank reverses a transfer.

Parameters	Description
event	It contains the name of the event which just occurred. Value = TRANSFER_REVERSED.
transferId	Id of the transfer passed by the merchant.
referenceId	Id of the transfer generated by Cashfree Payments.
eventTime	Time at which the transfer was reversed.
reason	Reason for failure.
signature	A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments.

---

CREDIT_CONFIRMATION

Sent when the balance credit is confirmed.

Parameters	Description
event	It contains the name of the event which just occurred. Value = CREDIT_CONFIRMATION.
ledgerBalance	The overall balance of ledger.
amount	Amount deposited.
utr	Unique transaction reference number provided by the bank.
signature	A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments.

---

TRANSFER_ACKNOWLEDGED

Sent when the bank acknowledges a transfer.

Parameters	Description
event	It contains the name of the event which just occurred. Value = TRANSFER_ACKNOWLEDGED.
transferId	Id of the transfer passed by the merchant.
referenceId	Id of the transfer generated by Cashfree Payments.
acknowledged	The flag which illustrates if the beneficiary bank acknowledges the transfer.
signature	A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments.

---

TRANSFER_REJECTED

Sent when a transfer is rejected.

Parameter	Description
event	It contains the name of the event which just occurred. Value = TRANSFER_REJECTED.
transferId	Id of the transfer passed by the merchant.
referenceId	Id of the transfer generated by Cashfree Payments.
reason	Reason for rejection.
signature	A unique string that helps distinguish that the request is genuine and initiated by Cashfree Payments.

---

BENEFICIARY_INCIDENT

Sent when a beneficiary incident is created or resolved.

Parameter	Description
event	It contains the name of the event which just occurred. Value = BENEFICIARY_INCIDENT.
beneEntity	The entity of the beneficiary (BANK).
id	Identifier of the incident.
mode	Mode of the incident (IMPS/NEFT)
startedAt	Start time of the incident.
status	Status of the incident (ACTIVE/RESOLVED).
isScheduled	Scheduled or unscheduled incident (true or false).
severity	The severity of the incident (LOW/HIGH).
entityName	Name of the entity on which incident is created (Bank Name).
entityCode	Code of the entity on which incident is created.
resolvedAt	Resolution time of the incident.

---

LOW_BALANCE_ALERT

Sent when the payout balance is low.

Parameter	Description
event	It contains the name of the event which just occurred. Value = LOW_BALANCE_ALERT
currentBalance	The current balance of the beneficiary account
alertTime	Alert initiation time.
signature	A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments.

BULK_TRANSFER_REJECTED

Sent when one of the transfers in the batch transfer file has been rejected.

Parameter	Description
event	One of the transfers in the batch transfer file has been rejected
transferId	It is the unique ID you created to identify the transfer
batchTransferReferenceId	It is the ID created by Cashfree Payments for internal reference.
eventTime	Event initiation time
reason	It describes the reason for the rejection.
signature	A unique string which helps distinguish that the request is genuine and initiated by Cashfree Payments.

Delay in Receiving the Response

Cashfree Payments receives a response from the bank with the status of the transfer instantly. At times the response may get delayed due to various reasons, and the transaction status will be marked as Pending, till we get a response.

Cashfree Payments polls the transaction status from the bank for the next 72 hours. In case we do not receive the status of a transaction after 72 hours, the transaction needs to be manually reconciled.

---

Signature Verification

Cashfree Payments sends a signature alongside every webhook, verifying this signature ( passed along with the POST parameters ) is mandatory before processing any response. It helps authenticate that the webhook is from Cashfree Payments.

We strongly recommend whitelisting Cashfree Payments production IP to help make your communication with us more secure.

Following are the steps to verify Cashfree Payments signature:

1. Get all the POST parameters except ‘signature’ and assign it to an array as key-value pair.
2. Sort the array based on keys.
3. Concatenate all the values in this array and resultant is the post data (say, postData).
4. postData needs to be encrypted using SHA-256, and then base64 encoded.
5. Now verify if both the signature calculated and the signature received match.
6. Proceed further if it matches, else discards the request.

Our libraries also support signature verification. To verify the signature returned by Cashfree Payments call the following methods from the library.

Below are the code snippets that can help you verify the signature:

PHP

<?php
  $data = $_POST;
  $signature = $_POST["signature"];
  unset($data["signature"]); // $data now has all the POST parameters except signature
  ksort($data); // Sort the $data array based on keys
  $postData = "";
  foreach ($data as $key => $value){
    if (strlen($value) > 0) {
      $postData .= $value;
    }
  }
  $hash_hmac = hash_hmac('sha256', $postData, $clientSecret, true) ;
  
  // Use the clientSecret from the oldest active Key Pair.
  $computedSignature = base64_encode($hash_hmac);
  if ($signature == $computedSignature) {
    // Proceed based on $event
  } else {
    // Reject this call
  }
?>

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.stream.Collectors;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import javax.crypto.spec.SecretKeySpec;
import javax.crypto.Mac;
import org.apache.commons.codec.binary.Base64;

public class ComputedSignature {

    public static boolean checkSignature(String clientSecret, String data) {

// write your code here
ObjectMapper objectMapper = new ObjectMapper();
String signatureKey = "signature";
String hash = "";
try {
Map<String, Object> jsonMap = objectMapper.readValue(data, new TypeReference<Map<String, Object>>(){});
String signature = jsonMap.get(signatureKey).toString();

            // remove the signature from map
            jsonMap.remove(signatureKey);
             Map<String, Object> sortedMap =  jsonMap.entrySet().
                     stream().
                     sorted(Map.Entry.comparingByKey()).
                     collect(Collectors.toMap(
                             Map.Entry::getKey,
                             Map.Entry::getValue,
                             (oldValue, newValue) -> oldValue, LinkedHashMap::new
                     ));

             // sort the map based on keys
             String postDataString = sortedMap.keySet().stream().map(key -> sortedMap.get(key).toString()).collect(Collectors.joining());

             // encode the post data on sha256
             Mac sha256HMAC = Mac.getInstance("HmacSHA256");
             SecretKeySpec secretKey  = new SecretKeySpec(clientSecret.getBytes(), "HmacSHA256");
             sha256HMAC.init(secretKey);

             hash = Base64.encodeBase64String(sha256HMAC.doFinal(postDataString.getBytes()));

             // check the hash generated with signature passed
             return hash.equals(signature);

        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

}

const Cashfree = require("cashfree-sdk");
//convert post response recived in the notification end point to json
//and pass that to the SDK.
Cashfree.Payouts.VerifySignature(webhookPostDataJson, signature, clientSecret);

from cashfree_sdk import verification

#webhook_data = response.content
webhook_data = '{"cashgramId": "5b8283182e0711eaa4c531df6a4f439b-28", "event": "CASHGRAM_EXPIRED", "eventTime": "2020-01-03 15:01:06", "reason": "OTP_ATTEMPTS_EXCEEDED", "signature": "TBpM+4nr1DsWsov7QiHSTfRJP4Z9BD8XrDgEhBlf9ss="}'
verification.verify_webhook(webhook_data, 'JSON')

Webhook Retries

Cashfree Payments webhooks service does its best to deliver events to your webhook endpoint. It is best practice for your application to respond to the callback. Our webhook service may send many payloads to a single endpoint in quick succession. You will need to build an application and configure your server to receive the response we send when events get triggered during the payout process.

Your server should return a 200 HTTP status code to acknowledge that you received the webhook without any issues. Any other information you return in the request headers or request body gets ignored. Any response code outside the 200 range, including 3xx codes, indicates that you did not receive the webhook.

When Cashfree Payments does not get the acknowledgement due to any reason, we retry to establish the communication at regular intervals. If we do not receive the response after few attempts, we gradually decrease the rate of retries. Based on this count, the service is disabled if it fails more than five times.

If do not receive notifications from Cashfree Payments as expected, please fill out the Support Form.

IPs to whitelist

When you decide to consume the webhooks, first, you need to verify if your systems need an IP whitelisting to be done at your end or not. Accordingly you can whitelist the below IPs of Cashfree:

UAT:
52.66.25.127
15.206.45.168

Prod:
52.66.101.190
3.109.102.144 18.60.134.245
18.60.183.142

Port: 443 (Secured)