Account capability

Account status

Billing

Charges

Connected Account Transfers

Conversions

Deposits

Direct debit payouts

Funds Split

Global Accounts

Balance

Issuing

Linked Accounts

Online payments

Platform

PSP Agnostic

Transfers

Event types

A quick introduction to the essential dev tools for building with Airwallex

Developer Essentials

Explore the flexibility and power of Airwallex APIs

Quickly and securely integrate with Airwallex products using Airwallex SDKs

SDKs

Learn how to receive push notifications via webhooks

Webhooks

Use Airwallex's demo environment to simulate transactions before going live

Demo environment

| 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. |
| Account Capability -> Pending | account_capability.pending | Capability is pending. |


| 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 |
| ------------ | ---------- | ----------- |
| 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     |
| ------------------- | ---------------- | ----------------|
| 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    |
| ----------- | ---------------- | ------------------- |
| Connected Account Transfer -> New     | connected_account_transfer.new     | The transfer transaction has been created successfully. |
| Connected Account Transfer -> Pending     | connected_account_transfer.pending     | The transfer transaction is in progress. |
| Connected Account Transfer -> Settled | connected_account_transfer.settled | Funds have settled in the target wallet.     |
| Connected Account Transfer -> Suspended | connected_account_transfer.suspended | The transfer transaction has been suspended after being reviewed by Airwallex.    |
| Connected Account Transfer -> Failed | connected_account_transfer.failed | The transfer transaction has failed.    |

This page describes conversion webhooks for __API version 2024-06-30 or later__. For older API versions, please see [conversion webhooks (legacy API versions)](/transactional-fx__conversions__conversion-webhooks-(legacy-api-versions)). 

| Web app Label                     | Event Type                     | Description                                                   |
| -------------------------------- | ------------------------------ | ------------------------------------------------------------- |
| Conversion -> Scheduled     | conversion.scheduled     | The conversion has been booked and scheduled for settlement on the conversion date.	 |
| Conversion -> Overdue | conversion.overdue | The settlement attempt has failed due to insufficient funds in the **sell currency** Wallet **past settlement cut-off time** for customers in post-funded mode.                                      |
| Conversion -> Settled            | conversion.settled             | Funds have been settled in the wallet.                        |
| Conversion -> Cancelled          | conversion.cancelled           | Conversion was cancelled. Funds have returned to client's Wallet.       |

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| Deposit -> Pending | deposit.pending             | Deposit is pending.                    |
| Deposit -> Settled | deposit.settled             | Deposit is successfully settled to Wallet.                    |
| Deposit -> Rejected | deposit.rejected             | Deposit is rejected after being reviewed by Airwallex or the clearing system.                    |
| Deposit -> Reversed | deposit.reversed             | Deposit is recalled by the payer’s bank after the funds were settled to your Wallet.                    |

| 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.   |

Global Account Statuses

Global Account Deposits

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| 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.                                  |

Card Status Webhooks

Card Delivery Status Webhooks

Cardholder Status Webhooks

Reissuance Webhooks

Transaction Webhooks

Dispute Webhooks

| 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 -> Updated    | payment\_intent.updated   | This payment intent has been updated with additional information.                                    |
| 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 -> Settled                          | refund.settled                            | This refund has been settled.                                                |
| 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.                                                                        |

| 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. |

Tax webhook events are in beta and may change in the future. Please contact your Account Manager for more details.

| Web app Label          | Event Type         | Description     |
| --------------------- | ------------------ | ------------ |
| Tax -> W9/W8 form -> Submitted | tax.tax_form.tax_id_verification_submitted | A tax form is submitted and pending verification. |
| Tax -> W9/W8 form -> Verification Failed | tax.tax_form.tax_id_verification_failed | A tax form’s (tax_id) verification has failed. The recipient should resubmit valid tax information.  |
| Tax -> W9/W8 form -> Ready | tax.tax_form.ready | A tax form’s (tax_id) verification is successful and is active or ready for submission. |
| Tax -> W9/W8 form -> Expired | tax.tax_form.expired | A tax form has expired. The recipient should resubmit valid tax information.  |
