BaaS webhooks enable you to receive updates about all event-driven activities originating from your account. Below is the list of transfer 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. |
| TRANSFER_ACKNOWLEDGED | After the beneficiary bank has deposited the money it confirms the transfer. |
| [TRANSFER_REJECTED] (https://docs.cashfree.com/reference/transfer-webhooks#transfer_rejected) | Sent whenever transfer is rejected due to invalid or missing details. |
TRANSFER_SUCCESS
Sent whenever a transfer is attempted successfully at the bank and the beneficiary account is debited.
| Parameters | Description |
|---|---|
| type | It contains the type of the event which just occurred. Value = TRANSFER_SUCCESS |
| event_time | Time at which the transfer was successful. |
| version | This denotes the version of the payload. |
| customer_id | A unique identifier to identify the customer to which this webhook belongs. |
| instrument_id | A unique identifier to identify the instrument to which this webhook belongs. |
| transfer_id | Id of the transfer passed by the Merchant. |
| bank_reference_number | Unique transaction reference number provided by the bank. |
| acknowledged | The flag which illustrates if the beneficiary bank acknowledges the transfer. |
TRANSFER_FAILED
Sent whenever a transfer attempt fails.
| Parameters | Description |
|---|---|
| type | It contains the type of the event which just occurred. Value = TRANSFER_FAILED |
| event_time | Time at which the transfer was failed. |
| version | This denotes the version of the payload. |
| customer_id | A unique identifier to identify the customer to which this webhook belongs. |
| instrument_id | A unique identifier to identify the instrument to which this webhook belongs. |
| transfer_id | Id of the transfer passed by the Merchant. |
| reason | Reason for failure. |
TRANSFER_REVERSED
Sent whenever the beneficiary bank reverses a transfer.
| Parameters | Description |
|---|---|
| type | It contains the type of the event which just occurred. Value = TRANSFER_REVERSED |
| event_time | Time at which the transfer was reversed. |
| version | This denotes the version of the payload. |
| customer_id | A unique identifier to identify the customer to which this webhook belongs. |
| instrument_id | A unique identifier to identify the instrument to which this webhook belongs. |
| transfer_id | Id of the transfer passed by the Merchant. |
| reason | Reason for reversal. |
TRANSFER_ACKNOWLEDGED
Sent whenever the bank acknowledges a transfer.
| Parameters | Description |
|---|---|
| type | It contains the type of the event which just occurred. Value = TRANSFER_ACKNOWLEDGED |
| event_time | Time at which the transfer was acknowledged. |
| version | This denotes the version of the payload. |
| customer_id | A unique identifier to identify the customer to which this webhook belongs. |
| instrument_id | A unique identifier to identify the instrument to which this webhook belongs. |
| transfer_id | Id of the transfer passed by the Merchant. |
| acknowledged | The flag which illustrates if the beneficiary bank acknowledges the transfer. |
TRANSFER_REJECTED
Sent whenever transfer is rejected due to invalid or missing details.
| Parameters | Description |
|---|---|
| type | It contains the type of the event which just occurred. Value = TRANSFER_REJECTED |
| event_time | Time at which the transfer was rejected. |
| version | This denotes the version of the payload. |
| customer_id | A unique identifier to identify the customer to which this webhook belongs. |
| instrument_id | A unique identifier to identify the instrument to which this webhook belongs. |
| transfer_id | Id of the transfer passed by the Merchant. |
| reason | Reason for rejection. |