Webhooks Configuration and Usage

Configure webhooks and use them to receive real-time updates on transaction events.

The following is the webhook payload for payments collected through the Virtual Bank Account (VBA):

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="
}

For settlement webhook, PG settlement payload will be sent to you on your endpoints from day 0 of migration. This might break consumption of settlement webhooks at your end if you are relying on settlement webhooks in AC payload format.

PG payload for 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, refer to PG Settlement Webhooks.