Batch transfer webhooks (older versions)
This page describes batch transfer webhooks for legacy API versions. For the latest version, please see batch transfer webhooks.
API ver. 2024-08-07 and before
| 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.