Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewHow Airwallex Payouts work
Payout network
Use cases
Batch transfers
Create a batch transfer
Batch transfer statuses
Retrieve batch transfersManage batch transfers
Test and go live
Older API versions

Batch transfer statuses

Batch transfer statuses

Batch transfer statuses

Batch transfer statuses in batch transfer approvals flow:

batch transfer approval flow

Batch Transfer StatusDescriptionWebhook Event TypeNext steps
DRAFTINGThe batch transfer is being drafted.batch_transfers.draftingSubmit a batch transfer when it is ready.
IN_APPROVAL*The batch transfer is submitted and waiting for approval.batch_transfers.in_approvalApprovers 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_recalledUsers 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_rejectedUsers 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_blockedAccount owner or Admin users can edit the approval workflow, then create a new batch transfer and resubmit for approval.
SCHEDULEDThe batch transfer is scheduled to create payouts once it is funded.batch_transfers.scheduledNo action needed.
OVERDUEThe batch transfer is not funded beyond the transfer date.batch_transfers.overdueRetrieve funding statuses for further details. Funding status of an OVERDUE batch transfer can be PROCESSING/FAILED.
BOOKINGThe batch transfer is in the process of creating payouts.batch_transfers.bookingNo action needed.
PARTIALLY_BOOKEDSome transfer items in the batch failed to be booked.batch_transfers.partially_bookedCall 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.
BOOKEDAll valid items in the batch transfer have been booked as payouts.batch_transfers.bookedNo action needed. You may retrieve details of each individual payout.
FAILEDThe batch transfer failed to be booked.batch_transfers.failedSee Batch transfer error codes to determine the next step based on your failure reason.
CANCELLATION_REQUESTEDBatch transfer cancellation has been requested before BOOKING, and will transition to CANCELLED.batch_transfers.cancellation_requestedNo action needed.
CANCELLEDThe batch transfer has been successfully cancelled.batch_transfers.cancelledNo 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.

Batch transfer funding status

Funding StatusDescriptionWebhook Event TypeNext steps
SCHEDULEDThe funding is scheduled to be processed on the transfer date.batch_transfers.funding.scheduledEnsure sufficient balance is available in the Airwallex Wallet or Linked Account to cover the batch transfer amount (including fees).
PROCESSINGThe funding for this batch transfer is being processed.batch_transfers.funding.processingFor batch transfers funded by Wallet, please ensure there is sufficient balance if status remains at PROCESSING.
FUNDEDThis batch transfer is successfully funded.batch_transfers.funding.fundedNo 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.failedSee 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.reversedNo 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 StatusDescriptionNext steps
VALIDATION_FAILEDThe transfer item failed validation.See Batch transfer item errors to determine the next step based on your failure reason.
VALIDATEDThe 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 transfer 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.

On this page
  • Batch transfer statuses
  • Funding statuses
  • Batch transfer item statuses