Payout webhooks (older versions)
This page applies for API version 2023-10-01 or earlier.
Payout
| Web app Label | Event Type | Description |
|---|---|---|
| Payout -> New | payment.new | You have successfully created the payout. |
| Payout -> In approval* | payment.in_approval | Payout is submitted for approval. Approvers can review the payout in the web app. |
| Payout -> Recalled* | payment.recalled | Payout is recalled by a user through the web app. Users can edit and resubmit the payout in the web app. |
| Payout -> Rejected* | payment.rejected | Payout is rejected by an approver through the web app. Users can edit and resubmit the payout in the web app. |
| Payout -> Blocked* | payment.blocked | Payout is blocked as the next approver cannot be found. Account owners or Admin users can edit the Transfers approval workflow and resubmit the payout in the web app. |
| Payout -> Pending funds* | payment.pending_funds | Payout is approved by all required approvers through the web app, and is waiting for funds to be available. |
| Payout -> In review | payment.in_review | The payout is on hold and being reviewed by Airwallex. |
| Payout -> Ready for dispatch | payment.ready_for_dispatch | The payout is ready for dispatch. |
| Payout -> Suspended | payment.suspended | The payout has been suspended after being reviewed by Airwallex. |
| Payout -> Dispatched | payment.dispatched | The payout has been dispatched from Airwallex. |
| Payout -> Failed | payment.failed | The payout has failed our banking partner’s processing or was rejected by the recipient bank. |
| Payout -> Cancellation requested | payment.cancellation_requested | Payout cancellation requested. Waiting for the currency conversion to be settled. |
| Payout -> Cancelled | payment.cancelled | The payout has been successfully cancelled. Funds will be returned to the Wallet. |
| Payout -> Retried | payment.retried | The failed payout has been retried with updated details and a new payout is successfully created. |
* These webhooks are only applicable to the payouts that are created and submitted for approval.
Payout to an Airwallex account
| Web app Label | Event Type | Description |
|---|---|---|
| Payout to an Airwallex account -> Created | wallet_transfer.created | You have successfully created the payout. |
| Payout to an Airwallex account -> Processing | wallet_transfer.processing | The payout is under processing by Airwallex. |
| Payout to an Airwallex account -> Sent | wallet_transfer.sent | The payout has been sent to the beneficiary. |
| Payout to an Airwallex account -> Settled | wallet_transfer.settled | The payout has been received by the beneficiary. |
| Payout to an Airwallex account -> Failed | wallet_transfer.failed | The payout has failed after being reviewed by Airwallex. |