# API key scopes A scoped API key is an API credential for your Airwallex account that grants **Read** or **Write** access to the resource areas you select, instead of full account access. Each scope controls which REST endpoints the key can call and which webhook events you can subscribe to when using that key, so you can give each integration only the access it needs. Scoped API keys are recommended for production integrations because they limit blast radius if a credential is exposed. For guidance on least privilege, migrating off admin keys, IP whitelisting, and key storage, see [API key best practices](https://www.airwallex.com/docs/developer-tools/api/api-key-best-practices.md). The tables below list every scope available when you create or edit a key. Use them to plan integrations, document access for your team, or look up what a scope enables when you configure keys in the [Airwallex web app](https://www.airwallex.com/app/). ## Scopes reference Scopes are grouped by product. For each scope, the table shows its label, authorized REST operations for Read and Write access, and webhook events. A dash means no APIs or events apply for that column. ### Account Capabilities | Resource | Read | Write | Webhook events | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Account Capabilities | [Get funding limits](https://www.airwallex.com/docs/api/account_capability/account_capability/funding_limits.md) [Get capability by ID](https://www.airwallex.com/docs/api/account_capability/account_capability/retrieve.md) | [Get funding limits](https://www.airwallex.com/docs/api/account_capability/account_capability/funding_limits.md) [Get capability by ID](https://www.airwallex.com/docs/api/account_capability/account_capability/retrieve.md) [Enable a capability](https://www.airwallex.com/docs/api/account_capability/account_capability/enable.md) | [account\_capability.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account\_capability.enabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account\_capability.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [seller.active](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [seller.in\_review](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [seller.inactive](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [seller.pending\_deactivation](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [seller.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [seller.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) | ### Billing | Resource | Read | Write | Webhook events | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Billing Checkouts | [Retrieve a Billing Checkout](https://www.airwallex.com/docs/api/billing/billing_checkouts/retrieve.md) [Get list of Billing Checkouts](https://www.airwallex.com/docs/api/billing/billing_checkouts/list.md) | [Create a Billing Checkout](https://www.airwallex.com/docs/api/billing/billing_checkouts/create.md) [Retrieve a Billing Checkout](https://www.airwallex.com/docs/api/billing/billing_checkouts/retrieve.md) [Get list of Billing Checkouts](https://www.airwallex.com/docs/api/billing/billing_checkouts/list.md) [Update a Billing Checkout](https://www.airwallex.com/docs/api/billing/billing_checkouts/update.md) [Cancel a Billing Checkout](https://www.airwallex.com/docs/api/billing/billing_checkouts/cancel.md) | [billing\_checkout.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [billing\_checkout.completed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [billing\_checkout.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) | | Billing Customers | [Retrieve a Billing Customer](https://www.airwallex.com/docs/api/billing/billing_customers/retrieve.md) [Get list of Billing Customers](https://www.airwallex.com/docs/api/billing/billing_customers/list.md) | [Create a Billing Customer](https://www.airwallex.com/docs/api/billing/billing_customers/create.md) [Retrieve a Billing Customer](https://www.airwallex.com/docs/api/billing/billing_customers/retrieve.md) [Update a Billing Customer](https://www.airwallex.com/docs/api/billing/billing_customers/update.md) [Get list of Billing Customers](https://www.airwallex.com/docs/api/billing/billing_customers/list.md) | - | | Billing Transactions | [Retrieve a Billing Transaction](https://www.airwallex.com/docs/api/billing/billing_transactions/retrieve.md) [Get list of Billing Transactions](https://www.airwallex.com/docs/api/billing/billing_transactions/list.md) | - | [billing\_transaction.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [billing\_transaction.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [billing\_transaction.succeeded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) | | Credit Notes | [Retrieve a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/retrieve.md) [Get list of Credit Notes](https://www.airwallex.com/docs/api/billing/credit_notes/list.md) [Retrieve a Credit Note Line Item](https://www.airwallex.com/docs/api/billing/credit_notes/retrieve_line_items.md) [Get list of Credit Note Line Items](https://www.airwallex.com/docs/api/billing/credit_notes/line_items.md) | [Create a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/create.md) [Retrieve a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/retrieve.md) [Get list of Credit Notes](https://www.airwallex.com/docs/api/billing/credit_notes/list.md) [Update a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/update.md) [Finalize a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/finalize.md) [Delete a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/delete.md) [Void a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/void.md) [Create Credit Note Line Items and add them to a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/add_line_items.md) [Retrieve a Credit Note Line Item](https://www.airwallex.com/docs/api/billing/credit_notes/retrieve_line_items.md) [Get list of Credit Note Line Items](https://www.airwallex.com/docs/api/billing/credit_notes/line_items.md) [Update Credit Note Line Items in a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/update_line_items.md) [Delete Credit Note Line Items from a Credit Note](https://www.airwallex.com/docs/api/billing/credit_notes/delete_line_items.md) | [credit\_note.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [credit\_note.finalized](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [credit\_note.voided](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) | | Discounts | [Retrieve a Coupon](https://www.airwallex.com/docs/api/billing/coupons/retrieve.md) [Get list of Coupons](https://www.airwallex.com/docs/api/billing/coupons/list.md) | [Create a Coupon](https://www.airwallex.com/docs/api/billing/coupons/create.md) [Update a Coupon](https://www.airwallex.com/docs/api/billing/coupons/update.md) [Retrieve a Coupon](https://www.airwallex.com/docs/api/billing/coupons/retrieve.md) [Get list of Coupons](https://www.airwallex.com/docs/api/billing/coupons/list.md) | - | | Invoices | [Retrieve an Invoice](https://www.airwallex.com/docs/api/billing/invoices/retrieve.md) [Get list of Invoices](https://www.airwallex.com/docs/api/billing/invoices/list.md) [Retrieve an Invoice Line Item](https://www.airwallex.com/docs/api/billing/invoices/retrieve_line_items.md) [Get list of Invoice Line Items](https://www.airwallex.com/docs/api/billing/invoices/line_items.md) | [Create an Invoice](https://www.airwallex.com/docs/api/billing/invoices/create.md) [Preview an Invoice](https://www.airwallex.com/docs/api/billing/invoices/preview.md) [Update an Invoice](https://www.airwallex.com/docs/api/billing/invoices/update.md) [Delete a draft Invoice](https://www.airwallex.com/docs/api/billing/invoices/delete.md) [Retrieve an Invoice](https://www.airwallex.com/docs/api/billing/invoices/retrieve.md) [Get list of Invoices](https://www.airwallex.com/docs/api/billing/invoices/list.md) [Finalize an Invoice](https://www.airwallex.com/docs/api/billing/invoices/finalize.md) [Mark an Invoice as paid](https://www.airwallex.com/docs/api/billing/invoices/mark_as_paid.md) [Void an Invoice](https://www.airwallex.com/docs/api/billing/invoices/void.md) [Create Invoice Line Items and add them to an Invoice](https://www.airwallex.com/docs/api/billing/invoices/add_line_items.md) [Retrieve an Invoice Line Item](https://www.airwallex.com/docs/api/billing/invoices/retrieve_line_items.md) [Get list of Invoice Line Items](https://www.airwallex.com/docs/api/billing/invoices/line_items.md) [Update Invoice Line Items in an Invoice](https://www.airwallex.com/docs/api/billing/invoices/update_line_items.md) [Delete Invoice Line Items within an Invoice](https://www.airwallex.com/docs/api/billing/invoices/delete_line_items.md) | [invoice.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.finalized](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.payment.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.payment\_attempt\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.payment\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.sent](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [invoice.voided](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) | | Payment Sources | [Retrieve a Payment Source](https://www.airwallex.com/docs/api/billing/payment_sources/retrieve.md) [Get List of Payment Sources](https://www.airwallex.com/docs/api/billing/payment_sources/list.md) | [Create a Payment Source](https://www.airwallex.com/docs/api/billing/payment_sources/create.md) [Retrieve a Payment Source](https://www.airwallex.com/docs/api/billing/payment_sources/retrieve.md) [Get List of Payment Sources](https://www.airwallex.com/docs/api/billing/payment_sources/list.md) | - | | Prices | [Retrieve a Price](https://www.airwallex.com/docs/api/billing/prices/retrieve.md) [Get list of Prices](https://www.airwallex.com/docs/api/billing/prices/list.md) | [Create a Price](https://www.airwallex.com/docs/api/billing/prices/create.md) [Retrieve a Price](https://www.airwallex.com/docs/api/billing/prices/retrieve.md) [Update a Price](https://www.airwallex.com/docs/api/billing/prices/update.md) [Get list of Prices](https://www.airwallex.com/docs/api/billing/prices/list.md) | - | | Products | [Retrieve a Product](https://www.airwallex.com/docs/api/billing/products/retrieve.md) [Get list of Products](https://www.airwallex.com/docs/api/billing/products/list.md) | [Create a Product](https://www.airwallex.com/docs/api/billing/products/create.md) [Retrieve a Product](https://www.airwallex.com/docs/api/billing/products/retrieve.md) [Update a Product](https://www.airwallex.com/docs/api/billing/products/update.md) [Get list of Products](https://www.airwallex.com/docs/api/billing/products/list.md) | - | | Subscriptions | [Retrieve a Subscription](https://www.airwallex.com/docs/api/billing/subscriptions/retrieve.md) [Get list of Subscriptions](https://www.airwallex.com/docs/api/billing/subscriptions/list.md) [Retrieve a Subscription Item](https://www.airwallex.com/docs/api/billing/subscriptions/retrieve_items.md) [Get list of Subscription Items](https://www.airwallex.com/docs/api/billing/subscriptions/items.md) | [Create a Subscription](https://www.airwallex.com/docs/api/billing/subscriptions/create.md) [Retrieve a Subscription](https://www.airwallex.com/docs/api/billing/subscriptions/retrieve.md) [Update a Subscription](https://www.airwallex.com/docs/api/billing/subscriptions/update.md) [Cancel a Subscription](https://www.airwallex.com/docs/api/billing/subscriptions/cancel.md) [Get list of Subscriptions](https://www.airwallex.com/docs/api/billing/subscriptions/list.md) [Retrieve a Subscription Item](https://www.airwallex.com/docs/api/billing/subscriptions/retrieve_items.md) [Get list of Subscription Items](https://www.airwallex.com/docs/api/billing/subscriptions/items.md) | [subscription.active](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [subscription.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [subscription.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [subscription.in\_trial](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [subscription.modified](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [subscription.unpaid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) [subscription.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) | | Usage Metering | [Retrieve a Meter](https://www.airwallex.com/docs/api/billing/meters/retrieve.md) [Get list of Meters](https://www.airwallex.com/docs/api/billing/meters/list.md) [Get summaries of a Meter](https://www.airwallex.com/docs/api/billing/meters/summaries.md) | [Create a Meter](https://www.airwallex.com/docs/api/billing/meters/create.md) [Retrieve a Meter](https://www.airwallex.com/docs/api/billing/meters/retrieve.md) [Update a Meter](https://www.airwallex.com/docs/api/billing/meters/update.md) [Archive a Meter](https://www.airwallex.com/docs/api/billing/meters/archive.md) [Restore a Meter](https://www.airwallex.com/docs/api/billing/meters/restore.md) [Get list of Meters](https://www.airwallex.com/docs/api/billing/meters/list.md) [Get summaries of a Meter](https://www.airwallex.com/docs/api/billing/meters/summaries.md) [Ingest a Usage Event](https://www.airwallex.com/docs/api/billing/usage_events/ingest.md) [Batch Ingest Usage Events](https://www.airwallex.com/docs/api/billing/usage_events/batch_ingest.md) [Void a Usage Event](https://www.airwallex.com/docs/api/billing/usage_events/void.md) | [usage\_event.aggregation\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/billing.md) (requires Write scope) | ### Core Resources | Resource | Read | Write | Webhook events | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Balances | [Get current balances](https://www.airwallex.com/docs/api/core_resources/balances/current.md) [Get balance history](https://www.airwallex.com/docs/api/core_resources/balances/history.md) | - | - | | Deposits | [Get a list of deposits](https://www.airwallex.com/docs/api/core_resources/deposits/list.md) [Get a deposit by ID](https://www.airwallex.com/docs/api/core_resources/deposits/retrieve.md) | [Get a list of deposits](https://www.airwallex.com/docs/api/core_resources/deposits/list.md) [Create a deposit via Direct Debit](https://www.airwallex.com/docs/api/core_resources/deposits/create.md) [Get a deposit by ID](https://www.airwallex.com/docs/api/core_resources/deposits/retrieve.md) | - | | Direct Debits | [Get list of direct debits](https://www.airwallex.com/docs/api/core_resources/direct_debits/list.md) [Get direct debit by ID](https://www.airwallex.com/docs/api/core_resources/direct_debits/retrieve.md) | [Get list of direct debits](https://www.airwallex.com/docs/api/core_resources/direct_debits/list.md) [Get direct debit by ID](https://www.airwallex.com/docs/api/core_resources/direct_debits/retrieve.md) [Cancel a direct debit by ID](https://www.airwallex.com/docs/api/core_resources/direct_debits/cancel.md) | [direct\_debit.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [direct\_debit.in\_review](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [direct\_debit.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [direct\_debit.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [direct\_debit.returned](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [direct\_debit.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) | | Global Accounts | [Get current balances](https://www.airwallex.com/docs/api/core_resources/balances/current.md) [Get balance history](https://www.airwallex.com/docs/api/core_resources/balances/history.md) [Get a list of global accounts](https://www.airwallex.com/docs/api/core_resources/global_accounts/list.md) [Get a List of Direct Debit Payout Mandates](https://www.airwallex.com/docs/api/core_resources/global_accounts/mandates.md) [Get a Direct Debit Payout Mandate by ID](https://www.airwallex.com/docs/api/core_resources/global_accounts/retrieve_mandates.md) [Get global account by ID](https://www.airwallex.com/docs/api/core_resources/global_accounts/retrieve.md) [Get global account transactions](https://www.airwallex.com/docs/api/core_resources/global_accounts/transactions.md) | [Get current balances](https://www.airwallex.com/docs/api/core_resources/balances/current.md) [Get balance history](https://www.airwallex.com/docs/api/core_resources/balances/history.md) [Get a list of global accounts](https://www.airwallex.com/docs/api/core_resources/global_accounts/list.md) [Create a global account](https://www.airwallex.com/docs/api/core_resources/global_accounts/create.md) [Get a List of Direct Debit Payout Mandates](https://www.airwallex.com/docs/api/core_resources/global_accounts/mandates.md) [Get a Direct Debit Payout Mandate by ID](https://www.airwallex.com/docs/api/core_resources/global_accounts/retrieve_mandates.md) [Cancel a Direct Debit Payout Mandate by ID](https://www.airwallex.com/docs/api/core_resources/global_accounts/cancel_mandates.md) [Get global account by ID](https://www.airwallex.com/docs/api/core_resources/global_accounts/retrieve.md) [Close a global account](https://www.airwallex.com/docs/api/core_resources/global_accounts/close.md) [Generate global account statement](https://www.airwallex.com/docs/api/core_resources/global_accounts/generate_statement_letter.md) [Get global account transactions](https://www.airwallex.com/docs/api/core_resources/global_accounts/transactions.md) [Update existing global account](https://www.airwallex.com/docs/api/core_resources/global_accounts/update.md) | [global\_account.active](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/global-accounts.md) [global\_account.closed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/global-accounts.md) [global\_account.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/global-accounts.md) | | Linked Accounts | [Get a list of Linked Accounts](https://www.airwallex.com/docs/api/core_resources/linked_accounts/list.md) [Get a Linked Account by ID](https://www.airwallex.com/docs/api/core_resources/linked_accounts/retrieve.md) [Get a Direct Debit Deposit Mandate](https://www.airwallex.com/docs/api/core_resources/linked_accounts/retrieve_mandate.md) [Check available balances](https://www.airwallex.com/docs/api/core_resources/linked_accounts/balances.md) | [Get a list of Linked Accounts](https://www.airwallex.com/docs/api/core_resources/linked_accounts/list.md) [Get a Linked Account by ID](https://www.airwallex.com/docs/api/core_resources/linked_accounts/retrieve.md) [Generate a Linked Account authentication](https://www.airwallex.com/docs/api/core_resources/linked_accounts/auth.md) [Create a Linked Account](https://www.airwallex.com/docs/api/core_resources/linked_accounts/create.md) [Refresh a Linked Account authentication](https://www.airwallex.com/docs/api/core_resources/linked_accounts/refresh.md) [Complete the authentication refresh](https://www.airwallex.com/docs/api/core_resources/linked_accounts/complete_auth.md) [Verify Linked Account with micro-deposits](https://www.airwallex.com/docs/api/core_resources/linked_accounts/verify_microdeposits.md) [Get a Direct Debit Deposit Mandate](https://www.airwallex.com/docs/api/core_resources/linked_accounts/retrieve_mandate.md) [Update a Direct Debit Deposit Mandate](https://www.airwallex.com/docs/api/core_resources/linked_accounts/mandate.md) [Check available balances](https://www.airwallex.com/docs/api/core_resources/linked_accounts/balances.md) [Suspend a Linked Account](https://www.airwallex.com/docs/api/core_resources/linked_accounts/suspend.md) [Confirm a Linked Account among candidate accounts](https://www.airwallex.com/docs/api/core_resources/linked_accounts/confirm.md) | [deposit.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/deposits.md) [deposit.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/deposits.md) [deposit.reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/deposits.md) [deposit.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/deposits.md) [linked\_account.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [linked\_account.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [linked\_account.requires\_action](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [linked\_account.succeeded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) [linked\_account.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/direct-debit-payouts.md) | ### Finance | Resource | Read | Write | Webhook events | | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | | Financial Reports | [Get list of financial reports](https://www.airwallex.com/docs/api/finance/financial_reports/list.md) [Get financial report by ID](https://www.airwallex.com/docs/api/finance/financial_reports/retrieve.md) [Get contents of a financial report](https://www.airwallex.com/docs/api/finance/financial_reports/content.md) | [Get list of financial reports](https://www.airwallex.com/docs/api/finance/financial_reports/list.md) [Create a financial report](https://www.airwallex.com/docs/api/finance/financial_reports/create.md) [Get financial report by ID](https://www.airwallex.com/docs/api/finance/financial_reports/retrieve.md) [Get contents of a financial report](https://www.airwallex.com/docs/api/finance/financial_reports/content.md) | - | | Financial Transactions | [Get list of financial transactions](https://www.airwallex.com/docs/api/finance/financial_transactions/list.md) [Get a financial transaction by ID](https://www.airwallex.com/docs/api/finance/financial_transactions/retrieve.md) | - | - | ### Issuing | Resource | Read | Write | Webhook events | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Authorizations and Transactions | [Get authorization status](https://www.airwallex.com/docs/api/issuing/authorizations/list.md) [Get single authorization status](https://www.airwallex.com/docs/api/issuing/authorizations/retrieve.md) [Get card transaction events](https://www.airwallex.com/docs/api/issuing/card_transaction_events/list.md) [Get single card transaction event](https://www.airwallex.com/docs/api/issuing/card_transaction_events/retrieve.md) [Get card transaction lifecycles](https://www.airwallex.com/docs/api/issuing/card_transaction_lifecycles/list.md) [Get single card transaction lifecycle](https://www.airwallex.com/docs/api/issuing/card_transaction_lifecycles/retrieve.md) [Get card transactions](https://www.airwallex.com/docs/api/issuing/card_transactions/list.md) [Get single card transaction](https://www.airwallex.com/docs/api/issuing/card_transactions/retrieve.md) [Get transactions](https://www.airwallex.com/docs/api/issuing/transactions/list.md) [Get single transaction](https://www.airwallex.com/docs/api/issuing/transactions/retrieve.md) | - | - | | Cardholders | [Get all cardholders](https://www.airwallex.com/docs/api/issuing/cardholders/list.md) [Get cardholder details](https://www.airwallex.com/docs/api/issuing/cardholders/retrieve.md) | [Create a cardholder](https://www.airwallex.com/docs/api/issuing/cardholders/create.md) [Update a cardholder](https://www.airwallex.com/docs/api/issuing/cardholders/update.md) [Delete cardholder](https://www.airwallex.com/docs/api/issuing/cardholders/delete.md) | [issuing.cardholder.deleted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.cardholder.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.cardholder.incomplete](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.cardholder.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.cardholder.ready](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) | | Cards | [Get sensitive card details](https://www.airwallex.com/docs/api/issuing/cards/details.md) [Get all cards](https://www.airwallex.com/docs/api/issuing/cards/list.md) [Get card details](https://www.airwallex.com/docs/api/issuing/cards/retrieve.md) [Get card remaining limits](https://www.airwallex.com/docs/api/issuing/cards/limits.md) | [Create a card](https://www.airwallex.com/docs/api/issuing/cards/create.md) [Activate a card](https://www.airwallex.com/docs/api/issuing/cards/activate.md) [Update a card](https://www.airwallex.com/docs/api/issuing/cards/update.md) | [issuing.card\_notification.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card\_notification.physical\_activated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.modified](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.inactive](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.active](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.lost](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.stolen](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.closed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.blocked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.expired](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.card.low\_remaining\_transaction\_limit](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) | | Config | [Get issuing config](https://www.airwallex.com/docs/api/issuing/config/retrieve.md) | [Update issuing config](https://www.airwallex.com/docs/api/issuing/config/update.md) | - | | Digital Wallet Tokens | [Get single digital wallet token](https://www.airwallex.com/docs/api/issuing/digital_wallet_tokens/retrieve.md) [Get all digital wallet tokens](https://www.airwallex.com/docs/api/issuing/digital_wallet_tokens/list.md) | - | [issuing.digital\_wallet\_notification.abandoned\_provisioning](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_notification.payment\_reminder](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_notification.token\_activated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_notification.token\_provisioning\_otp](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_notification.wallet\_available](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_token.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_token.provision\_attempted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.digital\_wallet\_token.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) | | Merchant Brands | [Get single Merchant Brand by id](https://www.airwallex.com/docs/api/issuing/merchant_brands/retrieve.md) [Get all Merchant Brands matching query](https://www.airwallex.com/docs/api/issuing/merchant_brands/list.md) | - | - | | Transaction Disputes | [Get a transaction dispute](https://www.airwallex.com/docs/api/issuing/transaction_disputes/retrieve.md) [Get all transaction disputes](https://www.airwallex.com/docs/api/issuing/transaction_disputes/list.md) | [Create a transaction dispute](https://www.airwallex.com/docs/api/issuing/transaction_disputes/create.md) [Update a transaction dispute](https://www.airwallex.com/docs/api/issuing/transaction_disputes/update.md) [Submit a transaction dispute](https://www.airwallex.com/docs/api/issuing/transaction_disputes/submit.md) [Cancel a transaction dispute](https://www.airwallex.com/docs/api/issuing/transaction_disputes/cancel.md) | [issuing.transaction\_dispute.accepted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.expired](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.lost](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.modified](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.submitted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction\_dispute.won](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) | ### Payment Acceptance | Resource | Read | Write | Webhook events | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Funds Splits | [Retrieve a FundsSplitReversal](https://www.airwallex.com/docs/api/payments/funds_split_reversals/retrieve.md) [Get list of FundsSplitReversals](https://www.airwallex.com/docs/api/payments/funds_split_reversals/list.md) [Retrieve a FundsSplit](https://www.airwallex.com/docs/api/payments/funds_splits/retrieve.md) [Get list of FundsSplits](https://www.airwallex.com/docs/api/payments/funds_splits/list.md) | [Create a FundsSplitReversal](https://www.airwallex.com/docs/api/payments/funds_split_reversals/create.md) [Create a FundsSplit](https://www.airwallex.com/docs/api/payments/funds_splits/create.md) [Release a FundsSplit](https://www.airwallex.com/docs/api/payments/funds_splits/release.md) | [funds\_split.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [funds\_split.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [funds\_split.released](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [funds\_split.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | Payment Acceptance | [Get list of settlements](https://www.airwallex.com/docs/api/finance/settlements/list.md) [Get a settlement by ID](https://www.airwallex.com/docs/api/finance/settlements/retrieve.md) [Get a settlement report by ID](https://www.airwallex.com/docs/api/finance/settlements/report.md) [Get Apple Pay Domains](https://www.airwallex.com/docs/api/payments/config/registered_domains.md) [Get convertible shopper currencies](https://www.airwallex.com/docs/api/payments/config/convertible_shopper_currencies.md) [Retrieve a Conversion Quote](https://www.airwallex.com/docs/api/payments/conversion_quotes/retrieve.md) [Retrieve a Customer](https://www.airwallex.com/docs/api/payments/customers/retrieve.md) [Generate a client secret for a Customer](https://www.airwallex.com/docs/api/payments/customers/generate_client_secret.md) [Get list of Customers](https://www.airwallex.com/docs/api/payments/customers/list.md) [Retrieve a PaymentAttempt by ID](https://www.airwallex.com/docs/api/payments/payment_attempts/retrieve.md) [Retrieve list of PaymentAttempts](https://www.airwallex.com/docs/api/payments/payment_attempts/list.md) [Retrieve a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/retrieve.md) [Get list of PaymentConsents](https://www.airwallex.com/docs/api/payments/payment_consents/list.md) [Retrieve a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/retrieve.md) [Get list of PaymentIntents](https://www.airwallex.com/docs/api/payments/payment_intents/list.md) [Retrieve a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/retrieve.md) [Get list of PaymentLinks](https://www.airwallex.com/docs/api/payments/payment_links/list.md) [Retrieve a PaymentMethod](https://www.airwallex.com/docs/api/payments/payment_methods/retrieve.md) [Get list of PaymentMethods](https://www.airwallex.com/docs/api/payments/payment_methods/list.md) [Retrieve BIN Info](https://www.airwallex.com/docs/api/payments/reference_data/lookup.md) [Retrieve a Refund](https://www.airwallex.com/docs/api/payments/refunds/retrieve.md) [Get list of Refunds](https://www.airwallex.com/docs/api/payments/refunds/list.md) | [Add Apple Pay Domains](https://www.airwallex.com/docs/api/payments/config/add_items_registered_domains.md) [Remove Apple Pay Domains](https://www.airwallex.com/docs/api/payments/config/remove_items_registered_domains.md) [Create a Conversion Quote](https://www.airwallex.com/docs/api/payments/conversion_quotes/create.md) [Create a Customer](https://www.airwallex.com/docs/api/payments/customers/create.md) [Update a Customer](https://www.airwallex.com/docs/api/payments/customers/update.md) [Create a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/create.md) [Update a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/update.md) [Verify a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/verify.md) [Continue to verify a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/verify_continue.md) [Disable a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/disable.md) [Create a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/create.md) [Update a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/update.md) [Confirm a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/confirm.md) [Continue to confirm a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/confirm_continue.md) [Increment Authorization for a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/increment_authorization.md) [Capture a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/capture.md) [Cancel a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/cancel.md) [Create a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/create.md) [Update a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/update.md) [Send a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/notify_shopper.md) [Activate a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/activate.md) [Deactivate a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/deactivate.md) [Create a Refund](https://www.airwallex.com/docs/api/payments/refunds/create.md) | [customer.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [customer.creation\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [customer.update\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [customer.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.authentication\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.authentication\_redirected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.authorization\_voided](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.authorized](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.capture\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.capture\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.captured](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.expired](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.failed\_to\_process](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.payment\_code\_generated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.payment\_code\_generation\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.pending\_authorization](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.received](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.risk\_declined](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_attempt.succeeded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.paused](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.requires\_customer\_action](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.requires\_payment\_method](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.verification\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_consent.verified](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.capture\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.customer\_action\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.merchant\_action\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.payment\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.payment\_method\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.requires\_capture](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.requires\_customer\_action](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.requires\_payment\_method](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.succeeded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_intent.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [refund.accepted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [refund.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [refund.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [refund.received](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [refund.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [refund.succeeded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | Payment Disputes | [Retrieve a PaymentDispute](https://www.airwallex.com/docs/api/payments/payment_disputes/retrieve.md) [Get list of PaymentDisputes](https://www.airwallex.com/docs/api/payments/payment_disputes/list.md) [Get list of Related Payment Intents](https://www.airwallex.com/docs/api/payments/payment_disputes/related_payment_intents.md) | [Retrieve a PaymentDispute](https://www.airwallex.com/docs/api/payments/payment_disputes/retrieve.md) [Get list of PaymentDisputes](https://www.airwallex.com/docs/api/payments/payment_disputes/list.md) [Accept a PaymentDispute](https://www.airwallex.com/docs/api/payments/payment_disputes/accept.md) [Challenge a PaymentDispute](https://www.airwallex.com/docs/api/payments/payment_disputes/challenge.md) [Get list of Related Payment Intents](https://www.airwallex.com/docs/api/payments/payment_disputes/related_payment_intents.md) | [dispute.accepted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.arbitration\_escalate\_received\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.dispute\_received\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.dispute\_responded\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.dispute\_reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.lost](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.pre\_arbitration\_received\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.pre\_chargeback\_accepted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.pre\_chargeback\_received\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.rfi\_received\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.rfi\_responded\_by\_merchant](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [dispute.won](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.accepted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.challenged](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.expired](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.lost](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.pending\_closure](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.pending\_decision](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.requires\_response](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_dispute.won](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.attached](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.attachment\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.creation\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.detached](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.detachment\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.disable\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_method.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | Payment Links | [Retrieve a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/retrieve.md) [Get list of PaymentLinks](https://www.airwallex.com/docs/api/payments/payment_links/list.md) | [Create a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/create.md) [Update a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/update.md) [Retrieve a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/retrieve.md) [Send a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/notify_shopper.md) [Activate a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/activate.md) [Deactivate a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/deactivate.md) [Get list of PaymentLinks](https://www.airwallex.com/docs/api/payments/payment_links/list.md) | [payment\_link.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [payment\_link.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | POS Terminals | [Retrieve a Terminal](https://www.airwallex.com/docs/api/payments/terminals/retrieve.md) [Get list of Terminals](https://www.airwallex.com/docs/api/payments/terminals/list.md) | [Create a Terminal](https://www.airwallex.com/docs/api/payments/terminals/create.md) [Process a PaymentIntent in a Terminal](https://www.airwallex.com/docs/api/payments/terminals/process_payment_intent.md) [Activate a Terminal](https://www.airwallex.com/docs/api/payments/terminals/activate.md) [Deactivate a Terminal](https://www.airwallex.com/docs/api/payments/terminals/deactivate.md) [Terminate a Terminal](https://www.airwallex.com/docs/api/payments/terminals/terminate.md) [Update a Terminal](https://www.airwallex.com/docs/api/payments/terminals/update.md) [Reset a Terminal password](https://www.airwallex.com/docs/api/payments/terminals/reset_password.md) | [pos.terminal.activated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.admin\_password\_status.activated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.admin\_password\_status.locked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.admin\_password\_status.reset\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.deactivated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.refund\_password\_status.activated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.refund\_password\_status.locked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.refund\_password\_status.opted\_out](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.refund\_password\_status.reset\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.terminated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [pos.terminal.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | ### Payouts | Resource | Read | Write | Webhook events | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Beneficiaries | [Get list of beneficiaries](https://www.airwallex.com/docs/api/payouts/beneficiaries/list.md) [Get a beneficiary by ID](https://www.airwallex.com/docs/api/payouts/beneficiaries/retrieve.md) | [Get list of beneficiaries](https://www.airwallex.com/docs/api/payouts/beneficiaries/list.md) [Create a new beneficiary](https://www.airwallex.com/docs/api/payouts/beneficiaries/create.md) [Validate beneficiary](https://www.airwallex.com/docs/api/payouts/beneficiaries/validate.md) [Get a beneficiary by ID](https://www.airwallex.com/docs/api/payouts/beneficiaries/retrieve.md) [Delete existing beneficiary](https://www.airwallex.com/docs/api/payouts/beneficiaries/delete.md) [Update existing beneficiary](https://www.airwallex.com/docs/api/payouts/beneficiaries/update.md) [Get the API schema](https://www.airwallex.com/docs/api/payouts/beneficiaries/generate_beneficiary_api_schemas.md) [Get the form schema](https://www.airwallex.com/docs/api/payouts/beneficiaries/generate_beneficiary_form_schemas.md) [Get supported financial institutions](https://www.airwallex.com/docs/api/payouts/beneficiaries/supported_financial_institutions.md) | - | | Transfers | [List all batch transfers](https://www.airwallex.com/docs/api/payouts/batch_transfers/list.md) [Retrieve a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/retrieve.md) [List all items within a batch](https://www.airwallex.com/docs/api/payouts/batch_transfers/items.md) [Get list of transfers](https://www.airwallex.com/docs/api/payouts/transfers/list.md) [Get transfer by ID](https://www.airwallex.com/docs/api/payouts/transfers/retrieve.md) [Supported currencies](https://www.airwallex.com/docs/api/supporting_services/reference_data/supported_currencies.md) | [Create confirmation letter](https://www.airwallex.com/docs/api/confirmation_letter/confirmation_letter/create.md) [List all batch transfers](https://www.airwallex.com/docs/api/payouts/batch_transfers/list.md) [Create a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/create.md) [Retrieve a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/retrieve.md) [Add items to a batch](https://www.airwallex.com/docs/api/payouts/batch_transfers/add_items.md) [Delete a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/delete.md) [Delete items within a batch](https://www.airwallex.com/docs/api/payouts/batch_transfers/delete_items.md) [List all items within a batch](https://www.airwallex.com/docs/api/payouts/batch_transfers/items.md) [Quote a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/quote.md) [Submit a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/submit.md) [Get list of transfers](https://www.airwallex.com/docs/api/payouts/transfers/list.md) [Create a new transfer](https://www.airwallex.com/docs/api/payouts/transfers/create.md) [Validate transfer](https://www.airwallex.com/docs/api/payouts/transfers/validate.md) [Get transfer by ID](https://www.airwallex.com/docs/api/payouts/transfers/retrieve.md) [Cancel a transfer](https://www.airwallex.com/docs/api/payouts/transfers/cancel.md) [Confirm funding for a transfer](https://www.airwallex.com/docs/api/payouts/transfers/confirm_funding.md) [Supported currencies](https://www.airwallex.com/docs/api/supporting_services/reference_data/supported_currencies.md) | [connected\_account\_transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) | ### Risk | Resource | Read | Write | Webhook events | | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Request for Information (RFI) | [List all RFIs](https://www.airwallex.com/docs/api/risk/request_for_information_rfi/list.md) [Retrieve an RFI](https://www.airwallex.com/docs/api/risk/request_for_information_rfi/retrieve.md) | [List all RFIs](https://www.airwallex.com/docs/api/risk/request_for_information_rfi/list.md) [Retrieve an RFI](https://www.airwallex.com/docs/api/risk/request_for_information_rfi/retrieve.md) [Respond to an RFI](https://www.airwallex.com/docs/api/risk/request_for_information_rfi/respond_rfis.md) | [rfi.action\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [rfi.answered](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) [rfi.closed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/rfi.md) | ### Connected Accounts | Resource | Read | Write | Webhook events | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Account | [Retrieve account details](https://www.airwallex.com/docs/api/scale/accounts/detail.md) | - | - | | Charges | [Get list of charges](https://www.airwallex.com/docs/api/scale/charges/list.md) [Get a charge by ID](https://www.airwallex.com/docs/api/scale/charges/retrieve.md) | [Create a new charge](https://www.airwallex.com/docs/api/scale/charges/create.md) | [charge.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/charges.md) [charge.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/charges.md) [charge.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/charges.md) [charge.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/charges.md) [charge.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/charges.md) | | Connected Accounts | [Get account by ID](https://www.airwallex.com/docs/api/scale/accounts/retrieve.md) [Get list of connected accounts](https://www.airwallex.com/docs/api/scale/accounts/list.md) | [Create an account](https://www.airwallex.com/docs/api/scale/accounts/create.md) [Update a connected account](https://www.airwallex.com/docs/api/scale/accounts/update.md) [Submit account for activation](https://www.airwallex.com/docs/api/scale/accounts/submit.md) [Agree to terms and conditions](https://www.airwallex.com/docs/api/scale/accounts/agree_terms_and_conditions.md) [Suspend account](https://www.airwallex.com/docs/api/scale/accounts/suspend.md) [Reactivate account](https://www.airwallex.com/docs/api/scale/accounts/reactivate.md) | [account.action\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account.active](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account.connected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account.submitted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) | | Hosted Flows | [Get flow](https://www.airwallex.com/docs/api/scale/hosted_flows/retrieve.md) | [Create flow](https://www.airwallex.com/docs/api/scale/hosted_flows/create.md) [Authorize flow](https://www.airwallex.com/docs/api/scale/hosted_flows/authorize.md) | - | | Invitation Links | [Get an account invitation link by ID](https://www.airwallex.com/docs/api/scale/invitation_links/retrieve.md) | [Create an account invitation link](https://www.airwallex.com/docs/api/scale/invitation_links/create.md) | - | | Offboarding | [List offboardings](https://www.airwallex.com/docs/api/scale/offboardings/list.md) [Get an offboarding by ID](https://www.airwallex.com/docs/api/scale/offboardings/retrieve.md) | [List offboardings](https://www.airwallex.com/docs/api/scale/offboardings/list.md) [Get an offboarding by ID](https://www.airwallex.com/docs/api/scale/offboardings/retrieve.md) [Create an offboarding](https://www.airwallex.com/docs/api/scale/offboardings/create.md) | - | | Platform Reports | [Get Platform report](https://www.airwallex.com/docs/api/scale/platform_reports/retrieve.md) | [Create Platform report](https://www.airwallex.com/docs/api/scale/platform_reports/create.md) | [platform\_report.completed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/platform.md) [platform\_report.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/platform.md) | | PSP Settlement Deposits | [Get a list of PSP settlement deposits](https://www.airwallex.com/docs/api/scale/psp_settlement_deposits/list.md) | - | [psp\_settlement\_deposit.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_deposit.action\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_deposit.matched](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_deposit.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) | | PSP Settlement Intents | [Get a PSP settlement intent by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/retrieve.md) [Get a list of PSP settlement intents](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/list.md) | [Get a PSP settlement intent by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/retrieve.md) [Get a list of PSP settlement intents](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/list.md) [Create a new PSP settlement intent](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/create.md) [Update a PSP settlement intent](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/update.md) [Cancel a PSP settlement intent by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/cancel.md) [Submit a PSP settlement intent by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_intents/submit.md) [Split a PSP settlement intent](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/split_psp_settlement_intents.md) | [psp\_settlement\_intent.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_intent.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_intent.submitted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_intent.action\_required](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_intent.matched](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_intent.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) | | PSP Settlement Splits | [Get a PSP settlement split by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/retrieve.md) [Get list of PSP settlement splits](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/list.md) | [Get a PSP settlement split by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/retrieve.md) [Get list of PSP settlement splits](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/list.md) [Release a PSP settlement split by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/release.md) [Cancel a PSP settlement split by ID](https://www.airwallex.com/docs/api/scale/psp_settlement_splits/cancel.md) | [psp\_settlement\_split.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_split.create\_failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_split.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_split.matched](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_split.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_split.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) [psp\_settlement\_split.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/psp-agnostic.md) | | Transfers | [Get list of connected account transfers](https://www.airwallex.com/docs/api/scale/connected_account_transfers/list.md) [Get a connected account transfer by ID](https://www.airwallex.com/docs/api/scale/connected_account_transfers/retrieve.md) | [Create a new connected account transfer](https://www.airwallex.com/docs/api/scale/connected_account_transfers/create.md) | [connected\_account\_transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [connected\_account\_transfer.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/connected-account-transfers.md) [transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.pending](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [transfer.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) | ### Simulations | Resource | Read | Write | Webhook events | | ----------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | | Simulations | - | [Accounts](https://www.airwallex.com/docs/api/simulation/accounts.md) [Billing](https://www.airwallex.com/docs/api/simulation/billing.md) [Deposits](https://www.airwallex.com/docs/api/simulation/deposits.md) [Issuing](https://www.airwallex.com/docs/api/simulation/issuing.md) [Linked Accounts](https://www.airwallex.com/docs/api/simulation/linked_accounts.md) [Payment Acceptance](https://www.airwallex.com/docs/api/simulation/payments.md) [Request for Information (RFI)](https://www.airwallex.com/docs/api/simulation/request_for_information_rfi.md) [Transfers](https://www.airwallex.com/docs/api/simulation/transfers.md) | - | ### Spend | Resource | Read | Write | Webhook events | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Bills | [List bills](https://www.airwallex.com/docs/api/spend/bills/list.md) [Get bill](https://www.airwallex.com/docs/api/spend/bills/retrieve.md) | [Create bill](https://www.airwallex.com/docs/api/spend/bills/create.md) [Update bill sync status](https://www.airwallex.com/docs/api/spend/bills/sync.md) [Mark bill as paid](https://www.airwallex.com/docs/api/spend/bills/mark_as_paid.md) | [spend.bill.awaiting\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.awaiting\_payment](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.payment\_in\_progress](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.bill.deleted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) | | Expenses | [List expenses](https://www.airwallex.com/docs/api/spend/expenses/list.md) [Get expense](https://www.airwallex.com/docs/api/spend/expenses/retrieve.md) [List reimbursement reports](https://www.airwallex.com/docs/api/spend/reimbursements/reimbursement_reports.md) [Get reimbursement report](https://www.airwallex.com/docs/api/spend/reimbursements/retrieve_reimbursement_reports.md) [List reimbursements](https://www.airwallex.com/docs/api/spend/reimbursements.md) [Get reimbursement](https://www.airwallex.com/docs/api/spend/reimbursements/retrieve.md) [Get reimbursement report transfer](https://www.airwallex.com/docs/api/spend/reimbursements/retrieve_transfers.md) | [Update expense sync status](https://www.airwallex.com/docs/api/spend/expenses/sync.md) [Update reimbursement report transfer sync status](https://www.airwallex.com/docs/api/spend/reimbursements/sync_transfers.md) [Update reimbursement report sync status](https://www.airwallex.com/docs/api/spend/reimbursements/sync_reimbursement_reports.md) [Mark reimbursement report as paid](https://www.airwallex.com/docs/api/spend/reimbursements/mark_as_paid_reimbursement_reports.md) | [spend.expense.draft](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.expense.awaiting\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.expense.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.expense.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.expense.approved](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.expense.archived](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.expense.deleted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.draft](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.awaiting\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.awaiting\_payment](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.payment\_in\_progress](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.mark\_as\_paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.deleted](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) [spend.reimbursement\_report.updated](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/spend.md) | | Purchase Orders | [List purchase orders](https://www.airwallex.com/docs/api/spend/purchase_orders/list.md) [Get purchase order](https://www.airwallex.com/docs/api/spend/purchase_orders/retrieve.md) | [Create purchase order](https://www.airwallex.com/docs/api/spend/purchase_orders/create.md) [Update purchase order sync status](https://www.airwallex.com/docs/api/spend/purchase_orders/sync.md) | - | | Vendors | [List vendors](https://www.airwallex.com/docs/api/spend/vendors/list.md) [Get vendor](https://www.airwallex.com/docs/api/spend/vendors/retrieve.md) | [Create vendor](https://www.airwallex.com/docs/api/spend/vendors/create.md) [Update vendor sync status](https://www.airwallex.com/docs/api/spend/vendors/sync.md) | - | ### Supporting Services | Resource | Read | Write | Webhook events | | ------------ | ---- | ---------------------------------------------------------------------------------------------------- | -------------- | | Upload Files | - | [Upload a file](https://www.airwallex.com/docs/api/supporting_services/file_service/upload_files.md) | - | ### Transactional FX | Resource | Read | Write | Webhook events | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | | Conversion | [Get current balances](https://www.airwallex.com/docs/api/core_resources/balances/current.md) [Get balance history](https://www.airwallex.com/docs/api/core_resources/balances/history.md) [Retrieve a conversion](https://www.airwallex.com/docs/api/transactional_fx/conversion/retrieve.md) [List all conversions](https://www.airwallex.com/docs/api/transactional_fx/conversion/list.md) [Retrieve an amendment](https://www.airwallex.com/docs/api/transactional_fx/conversion_amendments/retrieve.md) [List all amendments](https://www.airwallex.com/docs/api/transactional_fx/conversion_amendments/list.md) [Retrieve a quote](https://www.airwallex.com/docs/api/transactional_fx/quotes/retrieve.md) [Retrieve a current rate](https://www.airwallex.com/docs/api/transactional_fx/rates/current.md) | [Get current balances](https://www.airwallex.com/docs/api/core_resources/balances/current.md) [Get balance history](https://www.airwallex.com/docs/api/core_resources/balances/history.md) [Create a conversion](https://www.airwallex.com/docs/api/transactional_fx/conversion/create.md) [Retrieve a conversion](https://www.airwallex.com/docs/api/transactional_fx/conversion/retrieve.md) [List all conversions](https://www.airwallex.com/docs/api/transactional_fx/conversion/list.md) [Create an amendment quote](https://www.airwallex.com/docs/api/transactional_fx/conversion_amendments/quote.md) [Create an amendment](https://www.airwallex.com/docs/api/transactional_fx/conversion_amendments/create.md) [Retrieve an amendment](https://www.airwallex.com/docs/api/transactional_fx/conversion_amendments/retrieve.md) [List all amendments](https://www.airwallex.com/docs/api/transactional_fx/conversion_amendments/list.md) [Create a quote](https://www.airwallex.com/docs/api/transactional_fx/quotes/create.md) [Retrieve a quote](https://www.airwallex.com/docs/api/transactional_fx/quotes/retrieve.md) [Retrieve a current rate](https://www.airwallex.com/docs/api/transactional_fx/rates/current.md) | - |