Manage approvals for batch transfers
Introduction
Creating a batch transfer to be submitted for approval is available upon request. With this feature enabled, created batch transfers will be routed through the active transfer approval workflow in the Airwallex account.
Actions required to use this feature:
- Contact your account manager to enable this feature on API.
- Ensure that your Airwallex account has the new transfer approval feature. To confirm this, the account owner or admin should be able to create or edit transfer approval workflows on the Account > Approvals > Transfers page.
Handle approval for payouts
Submit batch transfers for approval
After a batch transfer has been created through the Client API, it may be routed through the approval process based on your active approval workflow, at which point its status will transition to IN_APPROVAL. Subscribe to the batch_transfers.in_approval webhook event to receive real-time notifications.
The submitter for the batch transfer depends on the authorization method.
- Your Airwallex account. This applies when the batch transfer creation requests are submitted with the Authorization token obtained using the method mentioned in Obtain access token API.
- A third-party app that you used to create the batch transfer. This applies when the payout creation requests are submitted with the Authorization code obtained using the method mentioned in Airwallex OAuth 2.0 API API.
To ensure a batch transfer cannot be approved by the same person that manually submits it from the external system, you need to avoid assigning them as approvers in the transfer approval workflow.
Approve batch transfers
After a batch transfer has been approved by a user in the web app, if there is additional approval required from other users, its status will remain as IN_APPROVAL. Otherwise, its status transitions to SCHEDULED. Subscribe to the batch_transfers.scheduled webhook event to receive real-time notifications of each batch transfer that has been fully approved for further processing.
Reject batch transfers
After a batch transfer has been rejected by a user in the web app, its status will transition to APPROVAL_REJECTED. Subscribe to the batch_transfers.approval_rejected webhook event to receive real-time notifications of each payout that has been rejected in the approval flow.
Recall batch transfers
After a batch transfer has been recalled by a user in the web app, it exits the approval process, at which point its status will transition to APPROVAL_RECALLED. Subscribe to the batch_transfers.approval_recalled webhook event to receive real-time notifications of each payout that has been recalled in the approval flow.
Handle blocked batch transfers
After a batch transfer has been approved by a user in the web app, if the next approver cannot be found, its status will transition to APPROVAL_BLOCKED. Subscribe to the batch_transfers.approval_blocked webhook event to receive real-time notifications of each batch transfer that has been blocked in the approval flow. The account owner or account admins need to fix any issues the approval workflow, then create a new batch transfer and submit again for approval.
Learn more about How to handle transfers that are blocked or stuck in approval .