Payouts
This page describes payout webhooks for API version 2024-01-31 or later. For older API versions, please see payout webhooks (older versions).
Payout
| Web app Label | Event Type | Description |
|---|---|---|
| Payout -> In approval* | payment.in_approval | The payout is submitted and waiting for approval. Approvers can review the payout in the web app. |
| Payout -> Approval Recalled* | payment.approval_recalled | Payout is recalled by a user through the web app. Users can edit and resubmit the payout in the web app. |
| Payout -> Approval Rejected* | payment.approval_rejected | Payout is rejected by an approver through the web app. Users can edit and resubmit the payout in the web app. |
| Payout -> Approval Blocked* | payment.approval_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 -> Scheduled | payment.scheduled | The payout is scheduled to be processed on the payout date if it is funded and passes review by Airwallex. |
| Payout -> Overdue | payment.overdue | The payout has not been funded by the scheduled date. Retrieve funding statuses for further details. Funding status of an overdue payout can be REQUIRES_FUNDING_CONFIRMATION/PROCESSING/FAILED. |
| Payout -> Processing | payment.processing | The payout is funded and being processed. Payout status will automatically transition to SENT when the payout is successfully sent to our banking partners, otherwise its status will transition to FAILED if it cannot be processed. |
| Payout -> Sent | payment.sent | The payout has been sent from Airwallex. |
| Payout -> Paid** | payment.paid | The payout has been processed successfully by our banking partner. |
| Payout -> Failed | payment.failed | The payout has failed our banking partner’s processing or was rejected by the recipient bank. Before a failed payout is automatically cancelled, you may cancel the payout. See Handle failed payouts to determine the next step based on your failure reason. |
| Payout -> Cancellation requested | payment.cancellation_requested | Payout cancellation has been requested before SENT, and will transition to CANCELLED when payout is successfully refunded. |
| Payout -> Cancelled | payment.cancelled | The payout has been successfully cancelled. Funds will be returned to the Wallet. |
| Payout -> Funding -> Requires funding confirmation*** | payment.funding.requires_funding_confirmation | The funding of this payout requires your confirmation under manual-funding mode. See Fund deduction for further details. |
| Payout -> Funding -> Scheduled*** | payment.funding.scheduled | The funding is scheduled to be processed on the payout date. |
| Payout -> Funding -> Processing*** | payment.funding.processing | The funding for this payout is being processed. |
| Payout -> Funding -> Failed*** | payment.funding.failed | Deposit via direct debit from a Linked Account is rejected as it failed validation by either Airwallex or the banking scheme. The funds will be returned to your external bank account. See failure reason for details and next step recommendations. |
| Payout -> Funding -> Funded*** | payment.funding.funded | This payout is successfully funded. |
| Payout -> Funding -> Reversed*** | payment.funding.reversed | If the external bank recalls the deposit via direct debit from a Linked Account after it has been settled into your Wallet, the status of the funding will be updated from to REVERSED, and the corresponding amount will be deducted from your Wallet balance. |
* These webhooks are only applicable to payouts that are created and submitted for approval.
** This webhook is only applicable to API version 2024-04-30 or after.
*** These webhooks are only applicable to payout funding events.
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. |