Transfer webhooks (older versions)
This page describes transfer webhooks for legacy API versions. For the latest version, please see transfer webhooks.
API ver. 2024-01-31 to 2024-08-07
| Web app Label | Event Type | Description |
|---|---|---|
| Transfer -> In approval* | payment.in_approval | The transfer is submitted and waiting for approval. Approvers can review the transfer in the web app. |
| Transfer -> Approval Recalled* | payment.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* | payment.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* | payment.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 | payment.scheduled | The transfer is scheduled to be processed on the transfer date if it is funded and passes review by Airwallex. |
| Transfer -> Overdue | payment.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 | payment.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 | payment.sent | The transfer has been sent from Airwallex. |
| Transfer -> Paid** | payment.paid | The transfer has been processed successfully by our banking partner. |
| Transfer -> Failed | payment.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 | payment.cancellation_requested | Transfer cancellation has been requested before SENT, and will transition to CANCELLED when transfer is successfully refunded. |
| Transfer -> Cancelled | payment.cancelled | The transfer has been successfully cancelled. Funds will be returned to the Wallet. |
| Transfer -> Funding -> Requires funding confirmation*** | payment.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*** | payment.funding.scheduled | The funding is scheduled to be processed on the transfer date. |
| Transfer -> Funding -> Processing*** | payment.funding.processing | The funding for this transfer is being processed. |
| Transfer -> 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. |
| Transfer -> Funding -> Funded*** | payment.funding.funded | This transfer is successfully funded. |
| Transfer -> 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 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.
API ver. 2023-10-01 and before
| Web app Label | Event Type | Description |
|---|---|---|
| Transfer -> New | payment.new | You have successfully created the transfer. |
| Transfer -> In approval* | payment.in_approval | Transfer is submitted for approval. Approvers can review the transfer in the web app. |
| Transfer -> Recalled* | payment.recalled | Transfer is recalled by a user through the web app. Users can edit and resubmit the transfer in the web app. |
| Transfer -> Rejected* | payment.rejected | Transfer is rejected by an approver through the web app. Users can edit and resubmit the transfer in the web app. |
| Transfer -> Blocked* | payment.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 -> Pending funds* | payment.pending_funds | Transfer is approved by all required approvers through the web app, and is waiting for funds to be available. |
| Transfer -> In review | payment.in_review | The transfer is on hold and being reviewed by Airwallex. |
| Transfer -> Ready for dispatch | payment.ready_for_dispatch | The transfer is ready for dispatch. |
| Transfer -> Suspended | payment.suspended | The transfer has been suspended after being reviewed by Airwallex. |
| Transfer -> Dispatched | payment.dispatched | The transfer has been dispatched from Airwallex. |
| Transfer -> Failed | payment.failed | The transfer has failed our banking partner’s processing or was rejected by the recipient bank. |
| Transfer -> Cancellation requested | payment.cancellation_requested | Transfer cancellation requested. Waiting for the currency conversion to be settled. |
| Transfer -> Cancelled | payment.cancelled | The transfer has been successfully cancelled. Funds will be returned to the Wallet. |
| Transfer -> Retried | payment.retried | The failed transfer has been retried with updated details and a new transfer is successfully created. |
* These webhooks are only applicable to the transfers that are created and submitted for approval.