Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
Get started
QuickstartManage API keys
Webhooks
Listen for webhook events
Event types
Account capabilityAccount statusBatch transfersBillingConversionsDepositsDirect debit payoutsFunds SplitGlobal AccountsIssuingLinked AccountsOnline paymentsPayouts
PlatformPSP AgnosticRFIScale ChargesScale Transfers
Payload examples
Code examples
Test webhook event payloadsView webhook eventsRe-trigger webhook events

Payouts

This page describes payout webhooks for API version 2024-01-31 or later. For older API versions, please see payout webhooks (older versions).

Payout

Web app LabelEvent TypeDescription
Payout -> In approval*payment.in_approvalThe payout is submitted and waiting for approval. Approvers can review the payout in the web app.
Payout -> Approval Recalled*payment.approval_recalledPayout is recalled by a user through the web app. Users can edit and resubmit the payout in the web app.
Payout -> Approval Rejected*payment.approval_rejectedPayout is rejected by an approver through the web app. Users can edit and resubmit the payout in the web app.
Payout -> Approval Blocked*payment.approval_blockedPayout is blocked as the next approver cannot be found. Account owners or Admin users can edit the Transfers approval workflow and resubmit the payout in the web app.
Payout -> Scheduledpayment.scheduledThe payout is scheduled to be processed on the payout date if it is funded and passes review by Airwallex.
Payout -> Overduepayment.overdueThe payout has not been funded by the scheduled date. Retrieve funding statuses for further details. Funding status of an overdue payout can be REQUIRES_FUNDING_CONFIRMATION/PROCESSING/FAILED.
Payout -> Processingpayment.processingThe payout is funded and being processed. Payout status will automatically transition to SENT when the payout is successfully sent to our banking partners, otherwise its status will transition to FAILED if it cannot be processed.
Payout -> Sentpayment.sentThe payout has been sent from Airwallex.
Payout -> Paid**payment.paidThe payout has been processed successfully by our banking partner.
Payout -> Failedpayment.failedThe payout has failed our banking partner’s processing or was rejected by the recipient bank. Before a failed payout is automatically cancelled, you may cancel the payout. See Handle failed payouts to determine the next step based on your failure reason.
Payout -> Cancellation requestedpayment.cancellation_requestedPayout cancellation has been requested before SENT, and will transition to CANCELLED when payout is successfully refunded.
Payout -> Cancelledpayment.cancelledThe payout has been successfully cancelled. Funds will be returned to the Wallet.
Payout -> Funding -> Requires funding confirmation***payment.funding.requires_funding_confirmationThe funding of this payout requires your confirmation under manual-funding mode. See Fund deduction for further details.
Payout -> Funding -> Scheduled***payment.funding.scheduledThe funding is scheduled to be processed on the payout date.
Payout -> Funding -> Processing***payment.funding.processingThe funding for this payout is being processed.
Payout -> Funding -> Failed***payment.funding.failedDeposit 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.
Payout -> Funding -> Funded***payment.funding.fundedThis payout is successfully funded.
Payout -> Funding -> Reversed***payment.funding.reversedIf 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 payouts 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 payout funding events.

Payout to an Airwallex account

Web app LabelEvent TypeDescription
Payout to an Airwallex account -> Createdwallet_transfer.createdYou have successfully created the payout.
Payout to an Airwallex account -> Processingwallet_transfer.processingThe payout is under processing by Airwallex.
Payout to an Airwallex account -> Sentwallet_transfer.sentThe payout has been sent to the beneficiary.
Payout to an Airwallex account -> Settledwallet_transfer.settledThe payout has been received by the beneficiary.
Payout to an Airwallex account -> Failedwallet_transfer.failedThe payout has failed after being reviewed by Airwallex.
On this page
  • Payout
  • Payout to an Airwallex account