Transfers
Transfers
This section describes transfer webhooks for the latest API version. For older API versions, please see transfer webhooks (older versions).
Web app Label | Event Type | Description |
---|---|---|
Transfer -> In approval* | payout.transfer.in_approval | The transfer is submitted and waiting for approval. Approvers can review the transfer in the web app. |
Transfer -> Approval Recalled* | payout.transfer.approval_recalled | Transfer is recalled by a user through the web app. Users can edit and resubmit the transfer in the web app. |
Transfer -> Approval Rejected* | payout.transfer.approval_rejected | Transfer is rejected by an approver through the web app. Users can edit and resubmit the transfer in the web app. |
Transfer -> Approval Blocked* | payout.transfer.approval_blocked | Transfer is blocked as the next approver cannot be found. Account owners or Admin users can edit the Transfers approval workflow and resubmit the transfer in the web app. |
Transfer -> Scheduled | payout.transfer.scheduled | The transfer is scheduled to be processed on the transfer date if it is funded and passes review by Airwallex. |
Transfer -> Overdue | payout.transfer.overdue | The transfer has not been funded by the scheduled date. Retrieve funding statuses for further details. Funding status of an overdue transfer can be REQUIRES_FUNDING_CONFIRMATION /PROCESSING /FAILED . |
Transfer -> Processing | payout.transfer.processing | The transfer is funded and being processed. Transfer status will automatically transition to SENT when the transfer is successfully sent to our banking partners, otherwise its status will transition to FAILED if it cannot be processed. |
Transfer -> Sent | payout.transfer.sent | The transfer has been sent from Airwallex. |
Transfer -> Paid** | payout.transfer.paid | The transfer has been processed successfully by our banking partner. |
Transfer -> Failed | payout.transfer.failed | The transfer has failed our banking partner’s processing or was rejected by the recipient bank. Before a failed transfer is automatically cancelled, you may cancel the transfer. See Handle failed transfers to determine the next step based on your failure reason. |
Transfer -> Cancellation requested | payout.transfer.cancellation_requested | Transfer cancellation has been requested before SENT , and will transition to CANCELLED when transfer is successfully refunded. |
Transfer -> Cancelled | payout.transfer.cancelled | The transfer has been successfully cancelled. Funds will be returned to the Wallet. |
Transfer -> Funding -> Requires funding confirmation*** | payout.transfer.funding.requires_funding_confirmation | The funding of this transfer requires your confirmation under manual-funding mode. See Fund deduction for further details. |
Transfer -> Funding -> Scheduled*** | payout.transfer.funding.scheduled | The funding is scheduled to be processed on the transfer date. |
Transfer -> Funding -> Processing*** | payout.transfer.funding.processing | The funding for this transfer is being processed. |
Transfer -> Funding -> Failed*** | payout.transfer.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. |
Transfer -> Funding -> Funded*** | payout.transfer.funding.funded | This transfer is successfully funded. |
Transfer -> Funding -> Reversed*** | payout.transfer.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 transfers 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 transfer funding events.
Batch transfers
Web app Label | Event Type | Description |
---|---|---|
Batch Transfers -> Drafted/Created | batch_transfers.drafting | The batch transfer is being drafted. Submit a batch transfer when all items are ready. |
Batch Transfers -> In approval* | batch_transfers.in_approval | The batch transfer is submitted for approval. Approvers can review the batch transfer in the web app. |
Batch Transfers -> Approval recalled* | batch_transfers.approval_recalled | The batch transfer is recalled by a user in the web app. |
Batch Transfers -> Approval rejected* | batch_transfers.approval_rejected | The batch transfer is rejected by an approver in the web app. |
Batch Transfers -> Approval blocked* | batch_transfers.approval_blocked | Batch transfer is blocked as next approver cannot be found. Account owner or Admin users should fix the approval workflow, then create a new batch transfer and submit again for approval. |
Batch Transfers -> Scheduled | batch_transfers.scheduled | The batch transfer is scheduled and will be processed to book transfers once it is funded. |
Batch Transfers -> Overdue | batch_transfers.overdue | The batch transfer has not been funded beyond the scheduled date. Please check funding status for details. |
Batch Transfers -> Booking | batch_transfers.booking | The batch transfer is being processed to book transfers. |
Batch Transfers -> Partially booked | batch_transfers.partially_booked | Some items in the batch failed to be booked. For each BOOKING_FAILED item, see Batch transfer error codes to determine the next step based on your failure reason. |
Batch Transfers -> Booked | batch_transfers.booked | All valid items in the batch transfer has been booked. You may retrieve details of each individual transfer. |
Batch Transfers -> Failed | batch_transfers.failed | The batch transfer failed to be booked. See Batch transfer error codes to determine the next step based on your failure reason. |
Batch Transfers -> Cancellation requested | batch_transfers.cancellation_requested | Batch transfer cancellation has been requested before BOOKING , and will transition to CANCELLED . |
Batch Transfers -> Cancelled | batch_transfers.cancelled | The batch transfer has been successfully cancelled. |
Batch Transfers -> Funding Scheduled** | batch_transfers.funding.scheduled | The funding is scheduled to be processed on the transfer date. |
Batch Transfers -> Funding Processing** | batch_transfers.funding.processing | The funding for this batch transfer is being processed. |
Batch Transfers -> Funded** | batch_transfers.funding.funded | This batch transfer is successfully funded. |
Batch Transfers -> Funding Failed** | batch_transfers.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. |
Batch Transfers -> Funding Reversed** | batch_transfers.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 batch transfers that are created and submitted for approval.
** These webhooks are only applicable to batch transfer funding events.
Transfer to an Airwallex account
Web app Label | Event Type | Description |
---|---|---|
Transfer to an Airwallex account -> Created | wallet_transfer.created | You have successfully created the transfer. |
Transfer to an Airwallex account -> Processing | wallet_transfer.processing | The transfer is under processing by Airwallex. |
Transfer to an Airwallex account -> Sent | wallet_transfer.sent | The transfer has been sent to the beneficiary. |
Transfer to an Airwallex account -> Settled | wallet_transfer.settled | The transfer has been received by the beneficiary. |
Transfer to an Airwallex account -> Failed | wallet_transfer.failed | The transfer has failed after being reviewed by Airwallex. |