Account capability

Account status

Batch payouts

Billing

Conversions

Deposits

Direct debit payouts

Funds Split

Global Accounts

Issuing

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 Payout -> Pending approval | batch.pending_approval | The batch payout has been submitted for approval. | 
| Batch Payout -> In preparation | batch.in_preparation | The batch payout has been approved and is pending until the scheduled date. | 
| Batch Payout -> Processing | batch.processing | The batch payout is being processed for dispatch. | 
| Batch Payout -> Processed | batch.processed | The batch payout has been dispatched from Airwallex. This does not imply the payouts have arrived. | 
| Batch Payout -> Cancelled | batch.cancelled | The batch payout has been cancelled. | 
| Batch Payout -> Funding | batch.funding.funding | The funding process for the batch payout has started. | 
| Batch Payout -> Funded | batch.funding.funded | The batch payout has been funded. | 
| Batch Payout -> Funding failed | batch.funding.failed | Funding of the batch payout was unsuccessful. | 
| Batch Payout -> Refunded | batch.funding.refunded | The funds for the batch payout have been returned to the source. | 

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

| 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.                                                      |
| Dispute -> Pre-chargeback received by merchant  |dispute.pre_chargeback_received_by_merchant  | Acquirer has detected a transaction that was processed via the [pre-chargeback process](/payments__disputes__dispute-flow-of-cards#pre-chargeback-process).|
| Dispute -> Pre-chargeback accepted  |dispute.pre_chargeback_accepted  | This dispute was resolved via the [pre-chargeback process](/payments__disputes__dispute-flow-of-cards#pre-chargeback-process).|
| Dispute -> RFI received by merchant          | dispute.rfi\_received\_by\_merchant         | Received RFI from acquirer.                                                                 |
| Dispute -> RFI responded by merchant         | dispute.rfi\_responded\_by\_merchant        | Merchant responded to RFI.                                                                  |
| Dispute -> Accepted                          | dispute.accepted                            | Merchant accepted the dispute.                                                              |
| Dispute -> Dispute received by merchant      | dispute.dispute\_received\_by\_merchant     | Acquirer required merchant to provide evidence for dispute stage.                           |
| Dispute -> Dispute responded by merchant     | dispute.dispute\_responded\_by\_merchant    | Merchant provided evidence for dispute stage.                                               |
| Dispute -> Won                               | dispute.won                                 | Merchant won the dispute (final result).                                                    |
| Dispute -> Lost                              | dispute.lost                                | Merchant lost the dispute (final result).                                                   |
| Dispute -> Dispute reversed                  | dispute.dispute\_reversed                   | Dispute is reversed                                                                         |
| 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.                                                                        |

__Payout__

| Web app Label       | Event Type        | Description         |
| ----------------- | ------------------| ---------------------------- |
| Payout -> New                       | payment.new                  | You have successfully created the payout.                          |
| Payout -> In approval* | payment.in_approval | Payout is submitted for approval. Approvers can review the payout in the web app. | 
| Payout -> Recalled* | payment.recalled | Payout is recalled by a user through the web app. Users can edit and resubmit the payout in the web app.| 
| Payout -> Rejected* | payment.rejected | Payout is rejected by an approver through the web app. Users can edit and resubmit the payout in the web app. | 
| Payout -> Blocked* | payment.blocked | Payout 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 -> Pending funds* | payment.pending_funds | Payout is approved by all required approvers through the web app, and is waiting for funds to be available. | 
| Payout -> In review                 | payment.in_review            | The payout is on hold and being reviewed by Airwallex.             |
| Payout -> Ready for dispatch        | payment.ready_for_dispatch   | The payout is ready for dispatch.                                  |
| Payout -> Suspended                 | payment.suspended            | The payout has been suspended after being reviewed by Airwallex.   |
| Payout -> Dispatched                | payment.dispatched           | The payout has been dispatched from Airwallex.                     |
| Payout -> Failed                    | payment.failed               | The payout has failed our banking partner’s processing or was rejected by the recipient bank.                    |                 
| Payout -> Cancellation requested | payment.cancellation_requested | Payout cancellation requested. Waiting for the currency conversion to be settled.        |
| Payout -> Cancelled              | payment.cancelled               | The payout has been successfully cancelled. Funds will be returned to the Wallet. |
| Payout -> Retried                | payment.retried                 | The failed payout has been retried with updated details and a new payout is successfully created.               |

\* These webhooks are only applicable to the payouts that are [created and submitted for approval](/payouts__manage-payouts__manage-approvals-for-payouts).

__Payout to an Airwallex account__

| Web app Label       | Event Type        | Description         |
| ----------------- | ------------------| ---------------------------- |
| Payout to an Airwallex account -> Created| wallet_transfer.created| You have successfully created the payout.|
| Payout to an Airwallex account -> Processing| wallet_transfer.processing| The payout is under processing by Airwallex.|
| Payout to an Airwallex account -> Sent| wallet_transfer.sent| The payout has been sent to the beneficiary.|
| Payout to an Airwallex account -> Settled| wallet_transfer.settled| The payout has been received by the beneficiary.|
| Payout to an Airwallex account -> Failed| wallet_transfer.failed| The payout has failed after being reviewed by Airwallex.|

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