Account capability

Account status

Batch transfers

Billing

Conversions

Deposits

Direct debit payouts

Funds Split

Global Accounts

Issuing

Linked Accounts

Online payments

Payouts

Platform

PSP Agnostic

Scale Charges

Scale Transfers

Event types

A quick introduction to building with Airwallex APIs

Quickstart

Explore our comprehensive reference to integrate with Airwallex API endpoints

API Reference

Learn how to receive push notifications via webhooks

Webhooks

| Web app Label         | Event Type        | Description        |
| -------------------- | ----------------- | ------------------- |
| Account Capability -> Enabled    | account_capability.enabled  | Capability has been enabled successfully.|                    |
| Account Capability -> Disabled | account_capability.disabled | Capability has been disabled or the enablement request has been rejected. |


| Web app Label         | Event Type        | Description                           |
| -------------------- | ----------------- | ------------------------------------- |
| Account -> Active    | account.active    | Account is active.                    |
| Account -> New account connected | account.connected | Account connected to another account. |
| Account -> Suspended | account.suspended | Account verification unsuccessful.    |
| Account -> Action Required | account.action_required | Account requires further action to proceed with verification.    |
| Account -> Submitted | account.submitted | Account is submitted. |

| 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 payouts 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](/payouts__create-a-batch-transfer__batch-transfer-statuses#funding-statuses) for details. | 
| Batch Transfers -> Booking | batch_transfers.booking | The batch transfer is being processed to book payouts. | 
| 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](/payouts__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 as payouts. You may retrieve details of each individual payout. | 
| Batch Transfers -> Failed | batch_transfers.failed | The batch transfer failed to be booked. See [Batch transfer error codes](/payouts__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](/payouts__manage-batch-transfers__manage-approvals-for-batch-transfers).

\** These webhooks are only applicable to batch transfer funding events.

| Web app Label | Event Type | Description |
| ------------ | ---------- | ----------- |
| Subscription -> Created                 | subscription.created       | A subscription has been created.        |
| Subscription -> Updated                 | subscription.updated       | The subscription has been changed, such as status update, trial start & end, cancel at period end, etc.   |
| Subscription -> Cancelled               | subscription.cancelled     | The subscription has been cancelled.    |
| Invoice -> Sent                         | invoice.sent               | The invoice is ready to be paid.        |
| Invoice -> Paid                         | invoice.paid               | The invoice has been paid successfully. |
| Invoice -> Payment failed               | invoice.payment\_failed    | The invoice is marked as PAYMENT_FAILED and should be treated as bad debt in the accounting process.           |
| Invoice -> Payment attempt failed               | invoice.payment_attempt_failed   | A payment attempt on the invoice failed. |

| Web app Label                     | Event Type                     | Description                                                   |
| -------------------------------- | ------------------------------ | ------------------------------------------------------------- |
| Conversion -> Awaiting funds     | conversion.awaiting\_funds     | Conversion booked successfully, and waiting for client funds. |
| Conversion -> Pending settlement | conversion.pending\_settlement | Conversion is processing                                      |
| Conversion -> Settled            | conversion.settled             | Funds have been settled in the wallet.                        |
| Conversion -> Pending rollover   | conversion.pending\_rollover   | Conversion is pending for rollover.                           |
| Conversion -> Rollover requested | conversion.rollover\_requested | Conversion is requested for rollover.                         |
| Conversion -> Cancelled          | conversion.cancelled           | Conversion cancelled.  Funds returned to client wallet.       |

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| Deposit -> Settled | deposit.settled             | Deposit is successfully settled to Wallet (currently only available for direct debit deposits).                    |
| Deposit -> Rejected | deposit.rejected             | Deposit is rejected after being reviewed by Airwallex or the clearing system (currently only available for direct debit deposits).                    |
| Deposit -> Reversed | deposit.reversed             | Deposit is recalled by the payer’s bank after the funds were settled to your Wallet (currently only available for direct debit deposits).                    |

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| Direct debit -> Created | direct_debit.created | Direct debit payout instruction received.                                  |
| Direct debit -> In review | direct_debit.in\_review | Direct debit payout is on hold for review. |
| Direct debit -> Pending | direct_debit.pending | Direct debit payout is pending for settlement.                                  |
| Direct debit -> Rejected | direct_debit.rejected | Direct debit payout was rejected after being reviewed.                                   |
| Direct debit -> Settled | direct_debit.settled | Direct debit payout has been debited from your Wallet balance.                                  |
| Direct debit -> Returned | direct_debit.returned | The request to dispute the payout was successful. The funds will be credited back to your Wallet balance.                                   |


| Web app Label         | Event Type        | Description  |
| ------------- | ----------------- | --------------------|
| Funds Split  -> Created    | funds_split.created    | A request to split funds is created.  |
| Funds Split  -> Failed  | funds_split.failed | The request to split funds has failed. |
| Funds Split  -> Released | funds_split.released | The release instruction to split funds is received.  |
| Funds Split  -> Settled | funds_split.settled | The funds have been split and settled into the destination account.   |

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| Global Account -> New | ga.new             | Deposit received via Global Account, pending settlement to Wallet balance.                    |
| Balance -> Add Funds    | balance.va.top\_up | Wallet balance increase due to deposit received via Virtual Account.   |
| Balance -> Collection | balance.ga.top\_up | Wallet balance increase due to deposit received via Global Account. |
| Balance -> Adjustment | balance.adjustment | Balance change due to adjustment.                                  |

| Web app Label                   | Event Type        | Description   |
| ------------------------------ | ----------------- | --------------|
| Cards -> Transaction Succeeded | issuing.transaction.succeeded | Successful transaction on an issued card. |
| Cards ->Transaction Failed     | issuing.transaction.failed    | Failed transaction on an issued card.     |
| Cards -> Reissue succeeded     | issuing.reissue.succeeded    | Successful reissue of an existing card.|

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| Linked Account -> Requires action | linked_account.requires_action             | Linked Account requires further action to proceed.                    |
| Linked Account -> Processing    | linked_account.processing | Linked Account is in the process of being set up.    |
| Linked Account -> Succeeded | linked_account.succeeded | Linked Account verification is successful and is active.  |
| Linked Account -> Failed | linked_account.failed | Linked Account failed verification or is inactive.  |
| Linked Account -> Suspended | linked_account.suspended | Linked Account is suspended.   |

| Web app Label    | Event Type             | Description   |
| ---------------------| -------------------| ----------------- |
| Payment Intent -> Created   | payment\_intent.created | A payment intent has been created.                                                          |
| Payment Intent -> Requires payment method    | payment\_intent.requires\_payment\_method   | This payment intent requires payment method to proceed.                                     |
| Payment Intent -> Requires capture   | payment\_intent.requires\_capture           | Merchant capture is required to fulfill this payment intent.  |
| Payment Intent -> Requires customer action   | payment\_intent.requires\_customer\_action  | Additional customer action is required to fulfill this payment intent.                       |
| Payment Intent -> Pending   | payment\_intent.pending    | The payment request has been accepted. Waiting for the final result. |
| Payment Intent -> Succeeded   | payment\_intent.succeeded                   | A payment intent has been fulfilled. |
| Payment Intent -> Cancelled  | payment\_intent.cancelled                   | The payment intent has been cancelled. |
| Payment Attempt -> Received  | payment\_attempt.received                   | This payment attempt has been received.  |
| Payment Attempt -> Authentication redirected | payment\_attempt.authentication\_redirected | The payment attempt has been redirected for authentication.  |
| Payment Attempt -> Pending authorization | payment\_attempt.pending\_authorization | The payment request has been accepted. Waiting for the final result. |
| Payment Attempt -> Authorized | payment\_attempt.authorized                 | The payment attempt has been authorized and is waiting to be captured.      |
| Payment Attempt -> Capture requested  | payment\_attempt.capture\_requested  | The payment attempt has been requested for capture successfully and is therefore fulfilled. |
| Payment Attempt -> Settled  | payment\_attempt.settled                    | This payment attempt's fund has been received by Airwallex from the acquirer. |
| Payment Attempt -> Paid | payment\_attempt.paid | This payment attempt's fund has been paid to the merchant's wallet successfully.            |
| Payment Attempt -> Cancelled                 | payment\_attempt.cancelled | The payment attempt has been cancelled. |
| Payment Attempt -> Expired | payment\_attempt.expired  | This payment attempt has expired. |
| Payment Attempt -> Risk declined  | payment\_attempt.risk\_declined   | The payment attempt has failed to pass the risk screen  |
| Payment Attempt -> Failed to process  | payment\_attempt.failed\_to\_process  | The payment attempt has failed to be processed.   |
| Payment Attempt -> Authentication failed     | payment\_attempt.authentication\_failed     | The payment attempt has failed to be authenticated.  |
| Payment Attempt -> Authorization failed | payment\_attempt.authorization\_failed      | The payment attempt has failed authorization.  |
| Payment Attempt -> Capture failed | payment\_attempt.capture\_failed            | The payment attempt has failed to capture and is therefore terminated.  |
| Payment Consent -> Created  | payment\_consent.created                    | The payment consent has been created   |
| Payment Consent -> Updated | payment\_consent.updated  | The payment consent has been updated  |
| Payment Consent -> Pending | payment\_consent.pending  | TThe mandate of the payment consent has been submitted. Wait for the final result.   |
| Payment Consent -> Verified | payment\_consent.verified                   | The payment consent has been verified   |
| Payment Consent -> Disabled  | payment\_consent.disabled                   | The payment consent has been disabled, the PaymentConsent cannot be used or updated         |
| Customer -> Created                          | customer.created                            | A customer has been created.                                                                |
| Customer -> Updated                          | customer.updated                            | The customer has been updated.                                                              |
| Refund -> Received                           | refund.received                             | This refund request has been received and will be processed later.                          |
| Refund -> Accepted                           | refund.accepted                             | This refund request has been accepted and started processing. Please note, the final fund settlement time will depend on the bank or the payment method's processing time.                                                                                             |
| Refund -> Succeeded                          | refund.succeeded                            | This refund has been fulfilled successfully.                                                |
| Refund -> Failed                             | refund.failed                               | This refund has failed.                                                                     |
| Payment Method -> Created                    | payment\_method.created                     | This payment method has been created.                                                       |
| Payment Method -> Updated                    | payment\_method.updated                     | This payment method has been updated.                                                       |
| Payment Method -> Attached                   | payment\_method.attached                    | This payment method has been attached to a customer.                                        |
| Payment Method -> Detached                   | payment\_method.detached                    | This payment method has been detached from a customer.                                      |
| Payment Method -> Disabled                   | payment\_method.disabled                    | This payment method has been disabled.                                                      |
| Payment Dispute -> Requires Response  |payment_dispute.requires_response  | You have received a dispute event, it requires your response.  [Dispute Flow](https://www.airwallex.com/docs/payments__disputes__dispute-flow-of-cards).|
| Payment Dispute -> Challenged          | payment_dispute.challenged         | You have challenged the dispute event, this is possible when you responded to RFI / Pre-chargeback / Chargeback   |
| Payment Dispute -> Accepted         | payment_dispute.accepted        | You have accepted the dispute event. |
| Payment Dispute -> Expired                          | payment_dispute.expired.  | Dispute event expired without response, this is applicable for dispute in RFI stage       |
| Payment Dispute -> Pending Closure |payment_dispute.pending_closure  | You have received a Pre-arbitration request which will be auto-accepted by Airwallex|
| Payment Dispute -> Pending Decision     | payment_dispute.pending_decision    | Your dispute response is not accepted, it has been escalated to Arbitration. Card brands will review the case and decide |
| Payment Dispute -> Won                               | payment_dispute.won | Issuing bank has accepted your response and you won the dispute. |
| Payment Dispute -> Lost  | payment_dispute.lost   | Issuing bank didn’t accept the dispute response you filed, you lost the dispute. No further action possible. |
| Payment Dispute -> Reversed      | payment_dispute.reversed     | Dispute event has been reversed, no further action required from your side   |
| Fraud -> Merchant notified                  | fraud.merchant_notified                   | This payment has been identified as fraudulent. Merchant to initiate refund and hold delivery of goods/service.   |
| Payment Link -> Created                  | payment_link.created                   | A payment link has been created and is waiting for payments.                                                                        |
| Payment Link -> Paid                  | payment_link.paid                   | The payment link received a new payment.                                                                        |

This page describes payout webhooks for __API version 2024-01-31 or later__.
For older API versions, please see [payout webhooks (older versions)](/payouts__payouts__payout-webhooks-(older-versions)).

Payout

Payout to an Airwallex account

| Web app Label     | Event Type     | Description    |
| ----------- | ---------------- | ------------------- |
| Platform Report -> Completed | platform_report.completed | Creation of Platform report completed. |
| Platform Report -> Failed | platform_report.failed | Creation of Platform report failed. |

Web app Label   |    Event Type  | Description |
|---------------|----------------|-------------|
|PSP Agnostic -> PSP settlement intent ->  Created |psp_settlement_intent.new | The PSP settlement intent has been successfully created.|
|PSP Agnostic -> PSP settlement intent ->  Cancelled |psp_settlement_intent.cancelled  | The PSP settlement intent has been successfully canceled.|
|PSP Agnostic -> PSP settlement intent ->  Submitted |psp_settlement_intent.submitted  | The PSP settlement intent has been successfully submitted.|
|PSP Agnostic -> PSP settlement intent ->  Action required |psp_settlement_intent.action_required  | The PSP settlement intent does not match the associated PSP settlement deposits.|
|PSP Agnostic -> PSP settlement intent ->  Matched |psp_settlement_intent.matched  | The PSP settlement intent matches the associated PSP settlement deposits.|
|PSP Agnostic -> PSP settlement intent ->  Settled |psp_settlement_intent.settled    | All the PSP settlement splits of the PSP settlement intent have been settled.|
|PSP Agnostic -> PSP settlement deposit ->  Created  |psp_settlement_deposit.new | Funds have been deposited into a holding account.|
|PSP Agnostic -> PSP settlement deposit ->  Action required   |psp_settlement_deposit.action_required | The PSP settlement deposit does not match any PSP settlement intent.|
|PSP Agnostic -> PSP settlement deposit ->  Matched           |psp_settlement_deposit.matched  | The PSP settlement deposits match the associated PSP settlement intent.|
|PSP Agnostic -> PSP settlement deposit ->  Settled           |psp_settlement_deposit.settled         | All the PSP settlement splits associated with this PSP settlement deposit have been settled.|
|PSP Agnostic -> PSP settlement split ->  Created             |psp_settlement_split.new  | The PSP settlement split has been successfully created.|
|PSP Agnostic -> PSP settlement split ->  Create Failed             |psp_settlement_split.create_failed  | The PSP settlement split could not be created.|
|PSP Agnostic -> PSP settlement split ->  Cancelled           |psp_settlement_split.cancelled         | The PSP settlement split has been successfully canceled.|
|PSP Agnostic -> PSP settlement split ->  Matched             |psp_settlement_split.matched           | The PSP settlement split is part of a PSP settlement intent that has been matched with its associated PSP deposits.|
|PSP Agnostic -> PSP settlement split ->  Pending              |psp_settlement_split.pending            | The PSP settlement split has been successfully queued for releasing funds to the target account.|
|PSP Agnostic -> PSP settlement split ->  Failed              |psp_settlement_split.failed            | The release of the PSP settlement split has failed, and no funds have been transferred to the target account.|
|PSP Agnostic -> PSP settlement split ->  Settled             |psp_settlement_split.settled           | The release of the PSP settlement split has succeeded, and the funds have settled to the target account.|

| Web app Label     | Event Type     | Description    |
| ----------- | ---------------- | ------------------- |
| RFI -> Action Required | rfi.action_required | RFI is pending answers. |
| RFI -> Answered | rfi.answered | RFI is answered. |
| RFI -> Closed | rfi.closed | RFI is finished and closed. |

| Web app Label        | Event Type       | Description     |
| ------------------- | ---------------- | ----------------|
| Charge -> New       | charge.new       | Charge transaction is created successfully. |
| Charge -> Pending   | charge.pending   | Charge transaction is in progress.          |
| Charge -> Settled   | charge.settled   | Funds have settled in the target wallet.   |
| Charge -> Suspended | charge.suspended | Charge transaction is suspended.            |
| Charge -> Failed | charge.failed | Charge transaction has failed.            |

| Web app Label     | Event Type     | Description    |
| ----------- | ---------------- | ------------------- |
| Transfer -> New     | transfer.new     | Transfer transaction is created successfully. |
| Transfer -> Pending     | transfer.pending     | Transfer transaction is in progress. |
| Transfer -> Settled | transfer.settled | Funds have settled in the target wallet.     |
| Transfer -> Suspended | transfer.suspended | Transfer transaction has been suspended after being reviewed by Airwallex.    |
| Transfer -> Failed | transfer.failed | Transfer transaction has failed.    |

The following pages detail the events that are available.

docsLogo

Desktop/Mobile Website Browser - Klarna

Dispute Management - Klarna

Extra Merchant Data (EMD) - Klarna

Klarna

Dispute Flow

Handling Disputes

Dispute Notifications

Pay with QR Code (Desktop Website Browser) - WeChat Pay

Mobile App - WeChat Pay 

WeChat Official Account - WeChat Pay

WeChat Mini Program - WeChat Pay

Mobile Browser (H5) - WeChat Pay

Customs Declaration - WeChat Pay

Funds Split - WeChat Pay

WeChat Pay

Refunds

Funds reconciliation

Pay with QR Code (Desktop Website Browser) - Touch 'n Go

Mobile Website Browser - Touch 'n Go

Mobile App - Touch 'n Go

Touch 'n Go

Pay with QR Code (Desktop Website Browser) - Rabbit LINE Pay

Mobile Website Browser - Rabbit LINE Pay

Mobile App - Rabbit Line Pay

Rabbit LINE Pay

Pay with QR Code (Desktop Website Browser) - GCash

Mobile Website Browser - GCash

Mobile App - GCash

GCash

Pay with QR Code (Desktop Website Browser) - DANA

Mobile Website Browser - DANA

Mobile App - DANA

DANA

Pay with QR Code (Desktop Website Browser) - TrueMoney

Mobile Website Browser - TrueMoney

Mobile App - TrueMoney

TrueMoney

Pay with QR Code (Desktop Website Browser) - Kakao Pay

Mobile Website Browser - Kakao Pay

Mobile App - Kakao Pay

Kakao Pay

Mobile App - Alipay CN

Mobile Website Browser - Alipay CN

Mini Program - Alipay CN

Customs Declaration - Alipay CN

Pay with QR Code (Desktop Website Browser) - Alipay CN

Alipay CN

Mobile App - Alipay HK

Mobile Website Browser - Alipay HK

Pay with QR Code (Desktop Website Browser) - Alipay HK

Alipay HK

Transaction failure reasons

Physical and digital cards (older API versions)

Cardholder statuses

Create individual cards (older API versions)

Card statuses

Create a card (older API versions)

Physical and digital cards

Create commercial cards

Create consumer cards

Whitelabel card offering

Create cards

Cardholder types

Create cardholders

Choose your issuing solution

Supported card programs

3D Secure authentication

Fund your issuing balance (older API versions)

Choose your issuing solution (older API versions)

Supported card types (older API versions)

Secure iframes

Retrieve sensitive card details

Fund your issuing balance

Platform issuing infrastructure for businesses

Consumer payouts via cards

Payout statuses

Generate a confirmation letter

Simulate payout status transition

Create a payout

 Payout error codes

Batch transfer error codes

Manage approvals for batch transfers

Manage batch transfers

Retrieve batch transfers

Batch transfer statuses

Create a batch transfer

Integration guide

Existing customers

New Airwallex customers

Implement your authorisation flow

Install the WooCommerce plugin

Enable Apple Pay (Express Checkout)

Enable Google Pay (Express checkout)

WooCommerce

Zambia

Angola

Test your custom domain

Remove your custom domain

Set Up your Custom Domain 

Custom Domains (Beta)

Togo

Senegal

Rwanda

Republic of the Congo

Paraguay

Powerful and flexible APIs to programmatically manage your money

Core API

APIs and components to build your own global financial products

Embedded Finance

Accept one-time and recurring payments, with like-for-like settlement for multiple currencies

PaymentsActive

PaymentsNormal

Accept payments from your customers around the world with cards and 160+ alternative payment methods. 

Overview

Payments

Choose your payments solution

Get started with payments

Payment Links

Invoice integrations

Manage payments

Payment methods

Test and go live

Troubleshooting

Access interbank FX rates and intelligently manage currency risk

FXActive

FXNormal

Access interbank FX rates and programmatically manage currency risk.

Transactional FX

How Transactional FX works

Supported regions and currencies

Funding and settlement models

Use Cases

Get started

Amendments

Programmatically make cost effective, fast and secure global payouts 

PayoutsActive

PayoutsNormal

Programmatically make cost-effective, fast and secure payouts across the globe.

How Airwallex Payouts work

Payout network

Use cases

Beneficiaries

Payers

Errors

Older API versions

Issue and manage multi-currency cards at scale, while reducing international transaction and FX fees

IssuingActive

IssuingNormal

Issue and manage multi-currency cards at scale, while reducing international transaction and FX fees.