OAuth scopes

Copy for LLMView as Markdown

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.

Business Accounts

Scope	APIs	Webhook events
balance:read	Get current balances API Get balance history API	balance.va.top_up balance.ga.top_up balance.adjustment
global_account:read	Get a list of global accounts API Get global account by ID API Generate global account statement API Get global account transactions API	ga.new
global_account:write	Get a list of global accounts API Get global account by ID API Generate global account statement API Get global account transactions API Update existing global account API	ga.new

Finance

Scope	APIs	Webhook events
financial_transaction:read	Get list of financial transactions API	-

Cards

Scope	APIs	Webhook events
issuing.card:read	Get all cards API Get card remaining limits API Get issuing config API	issuing.card_notification.created issuing.card_notification.physical_activated issuing.digital_wallet_notification.token_activated issuing.digital_wallet_notification.abandoned_provisioning issuing.digital_wallet_notification.payment_reminder issuing.digital_wallet_notification.token_provisioning_otp issuing.digital_wallet_notification.wallet_available issuing.digital_wallet_token.created issuing.digital_wallet_token.updated issuing.digital_wallet_token.provision_attempted
issuing.card:write	Create a card API Update a card API Activate a card API	issuing.card_notification.created issuing.card_notification.physical_activated issuing.digital_wallet_notification.token_activated issuing.digital_wallet_notification.abandoned_provisioning issuing.digital_wallet_notification.payment_reminder issuing.digital_wallet_notification.token_provisioning_otp issuing.digital_wallet_notification.wallet_available issuing.digital_wallet_token.created issuing.digital_wallet_token.updated issuing.digital_wallet_token.provision_attempted
issuing.cardholder:read	Get all cardholders API Get cardholder details API	-
issuing.cardholder:write	Create a cardholder API Update a cardholder API	-
issuing.transaction:read	Get transactions API Get single transaction API Get authorization status API Get single authorization status API	issuing.transaction.succeeded issuing.transaction.failed
issuing.merchant_brand:read	Get single Merchant Brand by id API Get all Merchant Brands matching query API	-

Payments

Scope	APIs	Webhook events
payment_link:read	Retrieve a PaymentLink API Get list of PaymentLinks API	-
payment_link:write	Retrieve a PaymentLink API Get list of PaymentLinks API Create a PaymentLink API Update a PaymentLink API Send a PaymentLink API Activate a PaymentLink API Deactivate a PaymentLink API Delete a PaymentLink API	-
payment_acceptance:read	Get list of PaymentIntents API Retrieve a PaymentIntent API Retrieve list of PaymentAttempts API Retrieve a PaymentAttempt by ID API Get list of settlements API Get a settlement by ID API Get a settlement report by ID API Get list of Refunds API Retrieve a Refund API Get available bank names API Get available payment method types API Get list of PaymentConsents API Retrieve a PaymentConsent API Get list of PaymentMethods API Retrieve a PaymentMethod API Get list of Customers API Retrieve a Customer API Generate a client secret for a Customer API	payment_intent.created payment_intent.cancelled payment_intent.pending payment_intent.succeeded payment_intent.requires_payment_method payment_intent.requires_customer_action payment_intent.requires_capture payment_attempt.received payment_attempt.risk_declined payment_attempt.pending_authorization payment_attempt.authorized payment_attempt.authorization_failed payment_attempt.capture_requested payment_attempt.capture_failed payment_attempt.authentication_redirected payment_attempt.authentication_failed payment_attempt.failed_to_process payment_attempt.cancelled payment_attempt.expired payment_attempt.settled payment_attempt.paid payment_method.created payment_method.updated payment_method.attached payment_method.detached payment_method.disabled customer.created customer.updated refund.received refund.accepted refund.settled refund.failed payment_consent.created payment_consent.updated payment_consent.pending payment_consent.verified payment_consent.disabled
payment_acceptance:write	Create a PaymentIntent API Cancel a PaymentIntent API Capture a PaymentIntent API Confirm a PaymentIntent API Continue to confirm a PaymentIntent API Create a Refund API Add PaymentMethod to Customer API Remove PaymentMethod from Customer API Update a Customer API Create a Customer API Disable a PaymentConsent API Update a PaymentConsent API Verify a PaymentConsent API Create a PaymentConsent API	payment_intent.created payment_intent.cancelled payment_intent.pending payment_intent.succeeded payment_intent.requires_payment_method payment_intent.requires_customer_action payment_intent.requires_capture payment_attempt.received payment_attempt.risk_declined payment_attempt.pending_authorization payment_attempt.authorized payment_attempt.authorization_failed payment_attempt.capture_requested payment_attempt.capture_failed payment_attempt.authentication_redirected payment_attempt.authentication_failed payment_attempt.failed_to_process payment_attempt.cancelled payment_attempt.expired payment_attempt.settled payment_attempt.paid payment_method.created payment_method.updated payment_method.attached payment_method.detached payment_method.disabled customer.created customer.updated refund.received refund.accepted refund.settled refund.failed payment_consent.created payment_consent.updated payment_consent.pending payment_consent.verified payment_consent.disabled
payment_dispute:read	Retrieve a PaymentDispute API Get list of PaymentDisputes API	payment_dispute.requires_response payment_dispute.expired payment_dispute.accepted payment_dispute.challenged payment_dispute.reversed payment_dispute.pending_decision payment_dispute.pending_closure payment_dispute.won payment_dispute.lost
payment_dispute:write	Accept a PaymentDispute API Challenge a PaymentDispute API	payment_dispute.requires_response payment_dispute.expired payment_dispute.accepted payment_dispute.challenged payment_dispute.reversed payment_dispute.pending_decision payment_dispute.pending_closure payment_dispute.won payment_dispute.lost
pos_terminal:read	Retrieve a Terminal API Get list of Terminals API	-
pos_terminal:write	Create a Terminal API Activate a Terminal API Deactivate a Terminal API Terminate a Terminal API Update a Terminal API Reset a Terminal password API Process a PaymentIntent in a Terminal API	-
funds_split:write	Create a FundsSplitReversal API Create a FundsSplit API Release a FundsSplit API	-
funds_split:read	Retrieve a FundsSplitReversal API Get list of FundsSplitReversals API Retrieve a FundsSplit API Get list of FundsSplits API	funds_split.created funds_split.failed funds_split.released funds_split.settled

Payouts

Scope	APIs	Webhook events
beneficiary:read	Get list of beneficiaries API Get a beneficiary by ID API	-
beneficiary:write	Get list of beneficiaries API Get a beneficiary by ID API Create a new beneficiary API Delete existing beneficiary API Update existing beneficiary API Validate beneficiary API Get the API schema API Get the form schema API	-
transfer:read	Get list of payments API Get payment by ID API Supported currencies API Retrieve a current rate API Get list of wallet transfers API Get a wallet transfer with transfer ID API List all batch transfers API Retrieve a batch transfer API List all items within a batch API	payout.transfer.in_approval payout.transfer.approval_rejected payout.transfer.approval_blocked payout.transfer.approval_recalled payout.transfer.scheduled payout.transfer.overdue payout.transfer.processing payout.transfer.sent payout.transfer.paid payout.transfer.failed payout.transfer.cancellation_requested payout.transfer.cancelled payout.transfer.funding.requires_funding_confirmation payout.transfer.funding.scheduled payout.transfer.funding.processing payout.transfer.funding.funded payout.transfer.funding.reversed payout.transfer.funding.failed wallet_transfer.created wallet_transfer.processing wallet_transfer.sent wallet_transfer.settled wallet_transfer.failed batch_transfers.drafting batch_transfers.in_approval batch_transfers.approval_rejected batch_transfers.approval_blocked batch_transfers.approval_recalled batch_transfers.scheduled batch_transfers.funding.requires_funding_confirmation batch_transfers.funding.scheduled batch_transfers.funding.processing batch_transfers.funding.funded batch_transfers.funding.reversed batch_transfers.funding.failed batch_transfers.overdue batch_transfers.booking batch_transfers.partially_booked batch_transfers.booked batch_transfers.failed batch_transfers.cancellation_requested batch_transfers.cancelled
transfer:write	Get list of payments API Get payment by ID API Cancel a new payment API Create a new payment API Retry a new payment API Update a payment API Validate a new payment API Supported currencies API Retrieve a current rate API Get list of wallet transfers API Get a wallet transfer with transfer ID API Create a new wallet transfer API List all batch transfers API Retrieve a batch transfer API List all items within a batch API Create a batch transfer API Add items to a batch API Delete a batch transfer API Delete items within a batch API Quote a batch transfer API Submit a batch transfer API	payout.transfer.in_approval payout.transfer.approval_rejected payout.transfer.approval_blocked payout.transfer.approval_recalled payout.transfer.scheduled payout.transfer.overdue payout.transfer.processing payout.transfer.sent payout.transfer.paid payout.transfer.failed payout.transfer.cancellation_requested payout.transfer.cancelled payout.transfer.funding.requires_funding_confirmation payout.transfer.funding.scheduled payout.transfer.funding.processing payout.transfer.funding.funded payout.transfer.funding.reversed payout.transfer.funding.failed wallet_transfer.created wallet_transfer.processing wallet_transfer.sent wallet_transfer.settled wallet_transfer.failed batch_transfers.drafting batch_transfers.in_approval batch_transfers.approval_rejected batch_transfers.approval_blocked batch_transfers.approval_recalled batch_transfers.scheduled batch_transfers.funding.requires_funding_confirmation batch_transfers.funding.scheduled batch_transfers.funding.processing batch_transfers.funding.funded batch_transfers.funding.reversed batch_transfers.funding.failed batch_transfers.overdue batch_transfers.booking batch_transfers.partially_booked batch_transfers.booked batch_transfers.failed batch_transfers.cancellation_requested batch_transfers.cancelled

Connected Accounts

Scope	APIs	Webhook events
platform_account:read	Retrieve account details API	account.active account.connected account.suspended account.action_required account.submitted

Simulations

Scope	APIs	Webhook events
simulation:write	Accounts API Billing API Deposits API Issuing API Linked Accounts API Payment Acceptance API Payouts API Request for Information (RFI) API Transfers API	-

Supporting Services

Scope	APIs	Webhook events
reference.order_item:read	Get expiring transfer or deposit limit API Get transfer or deposit limit API	-
reference.order_item:write	Increase transfer or deposit limit API	-
commerce_store:read	Get a list of e-commerce stores API Get an e-commerce store by id API	-
file:upload	Upload a file API	-

Transactional FX

Scope	APIs	Webhook events
fx.conversion:read	Retrieve a conversion API List all conversions API Retrieve an amendment API List all amendments API Retrieve a quote API Retrieve a current rate API	conversion.scheduled conversion.overdue conversion.settled conversion.cancelled
fx.conversion:write	Retrieve a conversion API List all conversions API Create a conversion API Create an amendment quote API Create an amendment API Retrieve an amendment API List all amendments API Retrieve a quote API Create a quote API Retrieve a current rate API	conversion.scheduled conversion.overdue conversion.settled conversion.cancelled

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
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
Finance	financial_transaction:read	r:awx_action:financial_transactions_view
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
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
Connected Accounts	platform_account:read	r:awx_action:settings.account_details_view
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

Was this page helpful?