Payout Payloads๐
The payload remains the same irrespective of the fund_account_type
to which payout was made. That is, the payload is same whether the payout was made to a bank account, vpa or card.
The table below lists the webhook events available for RazorpayX Payouts.
Webhook Event | Applicable For | Description |
---|---|---|
| all payouts | Triggered whenever a payout moves to the |
| all payouts | Triggered whenever a payout moves to the |
| all payouts |
|
| all payouts | Triggered when the payout moves to the |
| all payouts | Triggered when a payout moves to the |
| all payouts | Triggered whenever there is a change in the payout entity. For example, when we receive the UTR for the payout from the bank. For NEFT transactions, this webhook is fired within 90 seconds. For IMPS and UPI transactions, this webhook is generally fired immediately. |
| all payouts | Triggered whenever a payout fails and the amount is returned to your business account. |
| all payouts | Triggered when a payout is failed because the beneficiary bank OR NPCI OR processing partner bank is down. If the beneficiary bank/partner banks/NPCI does not recover within the stipulated SLA, a FAILED event will be sent with the respective reason. |
Order of Events๐
For example for payouts, you should receive webhooks in the following order:
payout.pending
(if you have Approval Workflow enabled on your account)payout.queued
(in case your business account does not have sufficient balance to process the payout)payout.initiated
payout.processed
orpayout.reversed
The above order may not be followed at all times. You should configure your webhook URL to not expect delivery of these events in this order and handle such scenarios.
The processed
and reversed
states are the last states for a payout. Their corresponding webhooks payout.processed
or payout.reversed
indicate this state change. Any webhook received after these should be ignored.
Handy Tips
The error
object has been deprecated.