# OAuth scopes An OAuth scope is a permission your application requests during the OAuth authorization flow. Each granted scope controls which REST endpoints your integration can call with an access token and which webhook events you can subscribe to for that connection, so you can give each integration only the access it needs. The tables below list every OAuth scope string available for your application, with each row mapping that string to the API operations and webhook events it covers. Use them to plan integrations, document access for your team, or look up what a scope enables when you build or troubleshoot your authorization flow. ## Scopes reference Scopes are grouped by product. For each scope, the table shows its label, authorized REST operations, and webhook events. A dash in the **Webhook events** column means no events apply. ### Accounts | Scope | APIs | Webhook events | | --------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | account\_details:read | [Retrieve account details](https://www.airwallex.com/docs/api/scale/accounts/detail.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.suspended](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/account.md) [account.action\_required](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) | ### Billing | Scope | APIs | Webhook events | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | billing.checkout:read | [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) | [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.checkout:write | [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.customer:read | [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) | - | | billing.customer:write | [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.transaction:read | [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) | | billing.credit\_note:read | [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) | [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) | | billing.credit\_note:write | [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) | | billing.discount:read | [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) | - | | billing.discount:write | [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) | - | | billing.invoice:read | [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) | [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) | | billing.invoice:write | [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) | | billing.payment\_source:read | [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) | - | | billing.payment\_source:write | [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) | - | | billing.price:read | [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) | - | | billing.price:write | [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) | - | | billing.product:read | [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) | - | | billing.product:write | [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) | - | | billing.subscription:read | [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) | [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) | | billing.subscription:write | [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) | | billing.usage\_metering:read | [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) | - | | billing.usage\_metering:write | [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) | ### Business Accounts | Scope | APIs | Webhook events | | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | balance:read | [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) | [balance.va.top\_up](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/balance.md) [balance.ga.top\_up](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/balance.md) [balance.adjustment](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/balance.md) | | global\_account:read | [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) [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) | [ga.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/global-accounts.md) | | global\_account:write | [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) | [ga.new](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/global-accounts.md) | ### Cards | Scope | APIs | Webhook events | | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | issuing.card:read | [Get all cards](https://www.airwallex.com/docs/api/issuing/cards/list.md) [Get card remaining limits](https://www.airwallex.com/docs/api/issuing/cards/limits.md) [Get issuing config](https://www.airwallex.com/docs/api/issuing/config/retrieve.md) [Get card details](https://www.airwallex.com/docs/api/issuing/cards/retrieve.md) [Get sensitive card details](https://www.airwallex.com/docs/api/issuing/cards/details.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) | | issuing.card:write | [Create a card](https://www.airwallex.com/docs/api/issuing/cards/create.md) [Update a card](https://www.airwallex.com/docs/api/issuing/cards/update.md) [Activate a card](https://www.airwallex.com/docs/api/issuing/cards/activate.md) | - | | issuing.cardholder:read | [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) | [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) | | issuing.cardholder:write | [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.transaction:read | [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) [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 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 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) | [issuing.transaction.succeeded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) [issuing.transaction.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/issuing.md) | | issuing.merchant\_brand:read | [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) | - | ### Finance | Scope | APIs | Webhook events | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | | financial\_report:read | [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) | - | | financial\_report:write | [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\_transaction:read | [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) | - | ### Payments | Scope | APIs | Webhook events | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | payment\_link:read | [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) | - | | payment\_link:write | [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) [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) | - | | payment\_acceptance:read | [Get list of PaymentIntents](https://www.airwallex.com/docs/api/payments/payment_intents/list.md) [Retrieve a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/retrieve.md) [Retrieve list of PaymentAttempts](https://www.airwallex.com/docs/api/payments/payment_attempts/list.md) [Retrieve a PaymentAttempt by ID](https://www.airwallex.com/docs/api/payments/payment_attempts/retrieve.md) [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 list of Refunds](https://www.airwallex.com/docs/api/payments/refunds/list.md) [Retrieve a Refund](https://www.airwallex.com/docs/api/payments/refunds/retrieve.md) [Get available bank names](https://www.airwallex.com/docs/api/payments/config/banks.md) [Get available payment method types](https://www.airwallex.com/docs/api/payments/config/payment_method_types.md) [Get list of PaymentConsents](https://www.airwallex.com/docs/api/payments/payment_consents/list.md) [Retrieve a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/retrieve.md) [Get list of PaymentMethods](https://www.airwallex.com/docs/api/payments/payment_methods/list.md) [Retrieve a PaymentMethod](https://www.airwallex.com/docs/api/payments/payment_methods/retrieve.md) [Get list of Customers](https://www.airwallex.com/docs/api/payments/customers/list.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 PaymentLinks](https://www.airwallex.com/docs/api/payments/payment_links/list.md) [Retrieve a PaymentLink](https://www.airwallex.com/docs/api/payments/payment_links/retrieve.md) [Get convertible shopper currencies](https://www.airwallex.com/docs/api/payments/config/convertible_shopper_currencies.md) [Get Apple Pay Domains](https://www.airwallex.com/docs/api/payments/config/registered_domains.md) [Retrieve a Conversion Quote](https://www.airwallex.com/docs/api/payments/conversion_quotes/retrieve.md) [Retrieve BIN Info](https://www.airwallex.com/docs/api/payments/reference_data/lookup.md) | [payment\_intent.created](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.pending](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.requires\_payment\_method](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\_capture](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\_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.pending\_authorization](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.authorization\_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.capture\_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.authentication\_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.cancelled](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.settled](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\_method.created](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\_method.attached](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.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [customer.created](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) [refund.received](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.settled](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) [payment\_consent.created](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.pending](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\_consent.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | payment\_acceptance:write | [Create a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/create.md) [Cancel a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/cancel.md) [Capture a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/capture.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) [Create a Refund](https://www.airwallex.com/docs/api/payments/refunds/create.md) [Add PaymentMethod to Customer](https://www.airwallex.com/docs/api/payments/payment_methods/create.md) [Remove PaymentMethod from Customer](https://www.airwallex.com/docs/api/payments/payment_methods/disable.md) [Update a Customer](https://www.airwallex.com/docs/api/payments/customers/update.md) [Create a Customer](https://www.airwallex.com/docs/api/payments/customers/create.md) [Disable a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/disable.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) [Create a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/create.md) [Continue to verify a PaymentConsent](https://www.airwallex.com/docs/api/payments/payment_consents/verify_continue.md) [Update a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/update.md) [Increment Authorization for a PaymentIntent](https://www.airwallex.com/docs/api/payments/payment_intents/increment_authorization.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 Conversion Quote](https://www.airwallex.com/docs/api/payments/conversion_quotes/create.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) | [payment\_intent.created](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.pending](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.requires\_payment\_method](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\_capture](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\_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.pending\_authorization](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.authorization\_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.capture\_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.authentication\_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.cancelled](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.settled](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\_method.created](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\_method.attached](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.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) [customer.created](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) [refund.received](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.settled](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) [payment\_consent.created](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.pending](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\_consent.disabled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | payment\_dispute:read | [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) | [payment\_dispute.requires\_response](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.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.reversed](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.pending\_closure](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\_dispute.lost](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | payment\_dispute:write | [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) [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) | [payment\_dispute.requires\_response](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.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.reversed](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.pending\_closure](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\_dispute.lost](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/online-payments.md) | | pos\_terminal:read | [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) | - | | pos\_terminal:write | [Create a Terminal](https://www.airwallex.com/docs/api/payments/terminals/create.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) [Process a PaymentIntent in a Terminal](https://www.airwallex.com/docs/api/payments/terminals/process_payment_intent.md) | - | | funds\_split:write | [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:read | [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) | [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) | ### Payouts | Scope | APIs | Webhook events | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | beneficiary:read | [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) | - | | beneficiary:write | [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) [Create a new beneficiary](https://www.airwallex.com/docs/api/payouts/beneficiaries/create.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) [Validate beneficiary](https://www.airwallex.com/docs/api/payouts/beneficiaries/validate.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) | - | | transfer:read | [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) [Retrieve a current rate](https://www.airwallex.com/docs/api/transactional_fx/rates/current.md) [Get list of wallet transfers](https://www.airwallex.com/docs/api/payouts/transfers/list.md) [Get a wallet transfer with transfer ID](https://www.airwallex.com/docs/api/payouts/transfers/retrieve.md) [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) | [payout.transfer.in\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.approval\_rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.approval\_blocked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.approval\_recalled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.overdue](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.sent](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.cancellation\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.requires\_funding\_confirmation](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.funded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.sent](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.drafting](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.in\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.approval\_rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.approval\_blocked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.approval\_recalled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.requires\_funding\_confirmation](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.funded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.overdue](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.booking](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.partially\_booked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.booked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.cancellation\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) | | transfer:write | [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) [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) [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) [Supported currencies](https://www.airwallex.com/docs/api/supporting_services/reference_data/supported_currencies.md) [Retrieve a current rate](https://www.airwallex.com/docs/api/transactional_fx/rates/current.md) [Get list of wallet transfers](https://www.airwallex.com/docs/api/payouts/transfers/list.md) [Get a wallet transfer with transfer ID](https://www.airwallex.com/docs/api/payouts/transfers/retrieve.md) [Create a new wallet transfer](https://www.airwallex.com/docs/api/payouts/transfers/create.md) [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) [Create a batch transfer](https://www.airwallex.com/docs/api/payouts/batch_transfers/create.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) [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) | [payout.transfer.in\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.approval\_rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.approval\_blocked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.approval\_recalled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.overdue](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.sent](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.paid](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.cancellation\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.requires\_funding\_confirmation](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.funded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [payout.transfer.funding.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.created](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.sent](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [wallet\_transfer.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.drafting](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.in\_approval](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.approval\_rejected](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.approval\_blocked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.approval\_recalled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.requires\_funding\_confirmation](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.processing](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.funded](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.reversed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.funding.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.overdue](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.booking](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.partially\_booked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.booked](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.failed](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.cancellation\_requested](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) [batch\_transfers.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/transfers.md) | ### Risk | Scope | APIs | Webhook events | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | risk.rfi:read | [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) | [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) | | risk.rfi:write | [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) | ### Simulations | Scope | APIs | Webhook events | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | | simulation:write | [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 | Scope | APIs | Webhook events | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | spend.bill:read | [List bills](https://www.airwallex.com/docs/api/spend/bills/list.md) [Get bill](https://www.airwallex.com/docs/api/spend/bills/retrieve.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) | | spend.bill:write | [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.expense:read | [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) | [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) | | spend.expense:write | [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.purchase\_order:read | [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) | - | | spend.purchase\_order:write | [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) | - | | spend.vendor:read | [List vendors](https://www.airwallex.com/docs/api/spend/vendors/list.md) [Get vendor](https://www.airwallex.com/docs/api/spend/vendors/retrieve.md) | - | | spend.vendor:write | [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 | Scope | APIs | Webhook events | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | | reference.order\_item:read | [Get expiring transfer or deposit limit](https://www.airwallex.com/docs/api/supporting_services/reference_data/expiring_quota.md) [Get transfer or deposit limit](https://www.airwallex.com/docs/api/supporting_services/reference_data/quota.md) | - | | reference.order\_item:write | [Increase transfer or deposit limit](https://www.airwallex.com/docs/api/supporting_services/reference_data/upload_order_items.md) | - | | commerce\_store:read | [Get a list of e-commerce stores](https://www.airwallex.com/docs/api/supporting_services/connected_stores/list.md) [Get an e-commerce store by id](https://www.airwallex.com/docs/api/supporting_services/connected_stores/retrieve.md) | - | | file:upload | [Upload a file](https://www.airwallex.com/docs/api/supporting_services/file_service/upload_files.md) | - | ### Transactional FX | Scope | APIs | Webhook events | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fx.conversion:read | [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) | [conversion.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) [conversion.overdue](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) [conversion.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) [conversion.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) | | fx.conversion:write | [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 a conversion](https://www.airwallex.com/docs/api/transactional_fx/conversion/create.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) [Retrieve a quote](https://www.airwallex.com/docs/api/transactional_fx/quotes/retrieve.md) [Create a quote](https://www.airwallex.com/docs/api/transactional_fx/quotes/create.md) [Retrieve a current rate](https://www.airwallex.com/docs/api/transactional_fx/rates/current.md) | [conversion.scheduled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) [conversion.overdue](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) [conversion.settled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) [conversion.cancelled](https://www.airwallex.com/docs/developer-tools/webhooks/listen-for-webhook-events/conversions.md) | ## Scope name mapping Airwallex is transitioning OAuth scope names to a shorter, more consistent format. The table below maps each scope listed above to its previous name. Both formats are accepted during the transition period. | Product | New scope name | Previous scope name | | ------------------- | ---------------------------- | --------------------------------------------- | | Accounts | account\_details:read | r:awx\_action:settings.account\_details\_view | | Business Accounts | balance:read | r:awx\_action:balances\_view | | Business Accounts | global\_account:read | r:awx\_action:global\_accounts\_view | | Business Accounts | global\_account:write | w:awx\_action:global\_accounts\_edit | | Cards | issuing.card:read | r:awx\_action:issuing\_cards\_view | | Cards | issuing.card:write | w:awx\_action:issuing\_cards\_edit | | Cards | issuing.cardholder:read | r:awx\_action:issuing\_cardholders\_view | | Cards | issuing.cardholder:write | w:awx\_action:issuing\_cardholders\_edit | | Cards | issuing.transaction:read | r:awx\_action:issuing\_transactions\_view | | Cards | issuing.merchant\_brand:read | r:awx\_action:issuing\_merchant\_brands\_view | | Finance | financial\_transaction:read | r:awx\_action:financial\_transactions\_view | | Payments | payment\_link:read | r:awx\_action:payment\_links\_view | | Payments | payment\_link:write | w:awx\_action:payment\_links\_edit | | Payments | payment\_acceptance:read | r:awx\_action:pa\_view | | Payments | payment\_acceptance:write | w:awx\_action:pa\_edit | | Payments | payment\_dispute:read | r:awx\_action:payment\_dispute\_view | | Payments | payment\_dispute:write | w:awx\_action:payment\_dispute\_edit | | Payments | pos\_terminal:read | r:awx\_action:pos\_terminals\_view | | Payments | pos\_terminal:write | w:awx\_action:pos\_terminals\_edit | | Payments | funds\_split:write | w:awx\_action:pa\_funds\_splits\_edit | | Payments | funds\_split:read | r:awx\_action:pa\_funds\_splits\_view | | Payouts | beneficiary:read | r:awx\_action:contact\_management\_view | | Payouts | beneficiary:write | w:awx\_action:contact\_management\_edit | | Payouts | transfer:read | r:awx\_action:transfers\_view | | Payouts | transfer:write | w:awx\_action:transfers\_edit | | Simulations | simulation:write | w:awx\_action:simulation\_edit | | Supporting Services | reference.order\_item:read | r:awx\_action:reference.order\_item\_view | | Supporting Services | reference.order\_item:write | w:awx\_action:reference.order\_item\_edit | | Supporting Services | commerce\_store:read | r:awx\_action:commerce\_stores\_view | | Supporting Services | file:upload | w:awx\_action:file\_upload | | Transactional FX | fx.conversion:read | r:awx\_action:conversions\_view | | Transactional FX | fx.conversion:write | w:awx\_action:conversions\_edit |