Webhooks Configuration and Usage

Configure Cashfree Virtual Bank Account webhooks to receive real-time events when customers send funds via IMPS, NEFT, or RTGS to virtual accounts.

Configure webhooks to receive real-time updates on transaction and settlement events for your Virtual Bank Account (VBA) integration.

For existing merchant integrations: The VBA_TRANSFER_SUCCESS_PAYMENT webhook remains the supported webhook for VBA transactions. If you configure the PAYMENT_SUCCESS_WEBHOOK, it does not include VBA-related transfer details. To receive VBA transfer updates, continue using the VBA_TRANSFER_SUCCESS_PAYMENT webhook.

For new merchant integrations: The VBA_TRANSFER_SUCCESS_PAYMENT webhook is not supported. Configure the PAYMENT_SUCCESS_WEBHOOK instead, which includes the VBA payment and transfer-related details your integration requires.

Payment success webhook

For newer integrations, use the PAYMENT_SUCCESS_WEBHOOK to receive VBA payment and transfer-related updates. The following sample shows the payload structure:

JSON

{
  "data": {
    "order": {
      "order_id": "n585ctivoh6g",
      "order_amount": 1500,
      "order_currency": "INR",
      "order_tags": null
    },
    "payment": {
      "cf_payment_id": "5114925103565",
      "payment_status": "SUCCESS",
      "payment_amount": 1500,
      "payment_currency": "INR",
      "payment_message": "NA",
      "payment_time": "2026-02-05T15:19:36+05:30",
      "bank_reference": "MerchantID_TESTUTR12362",
      "auth_id": null,
      "payment_method": {
        "vba_transfer": {
          "utr": "MerchantID_TESTUTR12362",
          "credit_ref_no": "NA",
          "remitter_account": "123456789012",
          "remitter_name": "John Doe",
          "remitter_ifsc": "NOOB0CMSNOC",
          "email": "[e-mail]",
          "phone": "9999999999",
          "vaccount_id": "USER09",
          "vaccount_number": "98912574JSER10"
        }
      },
      "payment_group": "vba_transfer",
      "international_payment": null,
      "payment_surcharge": {
        "payment_surcharge_service_charge": 0,
        "payment_surcharge_service_tax": 0
      }
    },
    "customer_details": {
      "customer_name": "John Doe",
      "customer_id": null,
      "customer_email": "[e-mail]",
      "customer_phone": "9999999999"
    },
    "payment_gateway_details": {
      "gateway_name": "CASHFREE",
      "gateway_order_id": null,
      "gateway_payment_id": null,
      "gateway_status_code": null,
      "gateway_order_reference_id": null,
      "gateway_settlement": "CASHFREE",
      "gateway_reference_name": null
    },
    "payment_offers": null,
    "terminal_details": null
  },
  "event_time": "2026-02-05T15:19:35+05:30",
  "type": "PAYMENT_SUCCESS_WEBHOOK"
}

Legacy VBA amount collected webhook

For existing integrations, Cashfree sends the following payload when a customer completes a payment to a Virtual Bank Account:

JSON

{
    "event":"AMOUNT_COLLECTED",
    "amount":"400",
    "vAccountId":"87654321",
    "virtualVpaId":"8080808087654321",
    "isVpa":"0",
    "email":"[e-mail]",
    "phone":"9876543210",
    "referenceId":87654,
    "utr":"N123456789",
    "creditRefNo":"0976541123",
    "remitterAccount":"123455666778",
    "remitterName":"CASHFREE PAYMENTS",
    "paymentTime":"2019-07-20 15:27:37",
    "signature":"8uV792gBZaasJHBFSsfaMHLuqnZKkossjw9gEJ8Sx85V+jgbpg4ME="
}

Settlement webhook

From day 0 of migration, Cashfree sends the PG settlement payload to your configured endpoints instead of the AC payload format. This change might break your integration if it relies on the AC settlement webhook format.

The following sample shows the PG payload for the settlement webhook:

JSON

{
    "data": {
        "settlement": {
            "adjustment": 0,
            "amount_settled": 97.94,
            "payment_amount": 100,
            "payment_from": "2022-02-14 12:00:00",
            "payment_till": "2022-02-14 12:15:00",
            "reason": null,
            "service_charge": 1.75,
            "service_tax": 0.31,
            "settled_on": "2022-02-14T12:35:19+05:30",
            "settlement_type": "STANDARD",   //settlement type//
            "settlement_amount": 97.94,
            "settlement_id": 738,
            "settlement_initiated_on": "2022-02-14T12:35:17+05:30",
            "status": "SUCCESS",
            "utr": 1644822317781212,
            "settlement_charge": 0,    // applicable for instant settlement //
            "settlement_tax": 0,       // applicable for instant settlement //
            "remarks": null    // applicable for instant settlement //
        }
    },
    "event_time": "2022-02-08T13:37:34+05:30",
    "type": "SETTLEMENT_SUCCESS"
}

For detailed information on PG settlement webhooks, see PG Settlement Webhooks.