Batch transfer statuses
Batch transfer statuses
Batch transfer statuses in batch transfer approvals flow:
| Batch Transfer Status | Description | Webhook Event Type | Next steps |
|---|---|---|---|
| DRAFTING | The batch transfer is being drafted. | batch_transfers.drafting | Submit a batch transfer when it is ready. |
| IN_APPROVAL* | The batch transfer is submitted and waiting for approval. | batch_transfers.in_approval | Approvers can review the batch transfer in the web app. |
| APPROVAL_RECALLED* | The batch transfer is recalled by a user in the web app. | batch_transfers.approval_recalled | Users can create a new batch transfer and resubmit for approval. |
| APPROVAL_REJECTED* | The batch transfer is rejected by an approver in the web app. | batch_transfers.approval_rejected | Users can create a new batch transfer and resubmit for approval. |
| APPROVAL_BLOCKED* | Batch transfer is blocked as next approver cannot be found. | batch_transfers.approval_blocked | Account owner or Admin users can edit the approval workflow, then create a new batch transfer and resubmit for approval. |
| SCHEDULED | The batch transfer is scheduled to create payouts once it is funded. | batch_transfers.scheduled | No action needed. |
| OVERDUE | The batch transfer is not funded beyond the transfer date. | batch_transfers.overdue | Retrieve funding statuses for further details. Funding status of an OVERDUE batch transfer can be PROCESSING/FAILED. |
| BOOKING | The batch transfer is in the process of creating payouts. | batch_transfers.booking | No action needed. |
| PARTIALLY_BOOKED | Some transfer items in the batch failed to be booked. | batch_transfers.partially_booked | Call List all items within a batch API to retrieve all transfer items. For each BOOKING_FAILED item, see Batch transfer item errors to determine the next step based on your failure reason. |
| BOOKED | All valid items in the batch transfer have been booked as payouts. | batch_transfers.booked | No action needed. You may retrieve details of each individual payout. |
| FAILED | The batch transfer failed to be booked. | batch_transfers.failed | See Batch transfer error codes to determine the next step based on your failure reason. |
| CANCELLATION_REQUESTED | Batch transfer cancellation has been requested before BOOKING, and will transition to CANCELLED. | batch_transfers.cancellation_requested | No action needed. |
| CANCELLED | The batch transfer has been successfully cancelled. | batch_transfers.cancelled | No action needed. |
* These statuses are only applicable to batch transfers that are created and submitted for approval.
Funding statuses
Funding statuses provide details on the funding of a batch transfer and can be retrieved from the funding object within the response of Batch Transfer API endpoints API. For example, when a batch transfer is OVERDUE, funding statuses will be helpful to understand the reason and next steps.
| Funding Status | Description | Webhook Event Type | Next steps |
|---|---|---|---|
| SCHEDULED | The funding is scheduled to be processed on the transfer date. | batch_transfers.funding.scheduled | Ensure sufficient balance is available in the Airwallex Wallet or Linked Account to cover the batch transfer amount (including fees). |
| PROCESSING | The funding for this batch transfer is being processed. | batch_transfers.funding.processing | For batch transfers funded by Wallet, please ensure there is sufficient balance if status remains at PROCESSING. |
| FUNDED | This batch transfer is successfully funded. | batch_transfers.funding.funded | No action needed. |
| 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.failed | See failure reason returned in the funding object for details and next step recommendations. |
| 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. | batch_transfers.funding.reversed | No action needed. |
** These statuses are only applicable to batch transfers funded via direct debits from Linked Accounts.
You can subscribe to Batch Transfers webhook events to receive the payout information in JSON payloads in case of any status transitions.
Batch transfer item statuses
Batch transfer item statuses provide validation and booking details for each item within a batch, these can be retrieved by calling List all items within a batch API.
| Batch Transfer Item Status | Description | Next steps |
|---|---|---|
| VALIDATION_FAILED | The transfer item failed validation. | See Batch transfer item errors to determine the next step based on your failure reason. |
| VALIDATED | The transfer item has been validated. | Submit the batch transfer when all items are validated. |
| BOOKING*** | The transfer item is being booked. | No action needed. |
| BOOKED*** | The transfer item has been successfully booked as a payout. | No action needed. You may retrieve details of this payout by calling Get payment by ID API. |
| BOOKING_FAILED*** | The transfer item failed to be booked. | See Batch transfer item errors to determine the next step based on your failure reason. |
*** These statuses are only applicable after the batch is submitted.