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.

Accounts

Scope	APIs	Webhook events
account_details:read	Retrieve account detailsAPI	account.active account.connected account.suspended account.action_required account.submitted

Billing

Scope	APIs	Webhook events
billing.checkout:read	Retrieve a Billing CheckoutAPI Get list of Billing CheckoutsAPI	billing_checkout.cancelled billing_checkout.completed billing_checkout.created
billing.checkout:write	Create a Billing CheckoutAPI Retrieve a Billing CheckoutAPI Get list of Billing CheckoutsAPI Update a Billing CheckoutAPI Cancel a Billing CheckoutAPI	billing_checkout.cancelled billing_checkout.completed billing_checkout.created
billing.customer:read	Retrieve a Billing CustomerAPI Get list of Billing CustomersAPI	-
billing.customer:write	Create a Billing CustomerAPI Retrieve a Billing CustomerAPI Update a Billing CustomerAPI Get list of Billing CustomersAPI	-
billing.transaction:read	Retrieve a Billing TransactionAPI Get list of Billing TransactionsAPI	billing_transaction.cancelled billing_transaction.created billing_transaction.succeeded
billing.credit_note:read	Retrieve a Credit NoteAPI Get list of Credit NotesAPI Retrieve a Credit Note Line ItemAPI Get list of Credit Note Line ItemsAPI	credit_note.created credit_note.finalized credit_note.voided
billing.credit_note:write	Create a Credit NoteAPI Retrieve a Credit NoteAPI Get list of Credit NotesAPI Update a Credit NoteAPI Finalize a Credit NoteAPI Delete a Credit NoteAPI Void a Credit NoteAPI Create Credit Note Line Items and add them to a Credit NoteAPI Retrieve a Credit Note Line ItemAPI Get list of Credit Note Line ItemsAPI Update Credit Note Line Items in a Credit NoteAPI Delete Credit Note Line Items from a Credit NoteAPI	credit_note.created credit_note.finalized credit_note.voided
billing.discount:read	Retrieve a CouponAPI Get list of CouponsAPI	-
billing.discount:write	Create a CouponAPI Update a CouponAPI Retrieve a CouponAPI Get list of CouponsAPI	-
billing.invoice:read	Retrieve an InvoiceAPI Get list of InvoicesAPI Retrieve an Invoice Line ItemAPI Get list of Invoice Line ItemsAPI	invoice.created invoice.finalized invoice.paid invoice.payment.paid invoice.payment_attempt_failed invoice.payment_failed invoice.sent invoice.voided
billing.invoice:write	Create an InvoiceAPI Preview an InvoiceAPI Update an InvoiceAPI Delete a draft InvoiceAPI Retrieve an InvoiceAPI Get list of InvoicesAPI Finalize an InvoiceAPI Mark an Invoice as paidAPI Void an InvoiceAPI Create Invoice Line Items and add them to an InvoiceAPI Retrieve an Invoice Line ItemAPI Get list of Invoice Line ItemsAPI Update Invoice Line Items in an InvoiceAPI Delete Invoice Line Items within an InvoiceAPI	invoice.created invoice.finalized invoice.paid invoice.payment.paid invoice.payment_attempt_failed invoice.payment_failed invoice.sent invoice.voided
billing.payment_source:read	Retrieve a Payment SourceAPI Get List of Payment SourcesAPI	-
billing.payment_source:write	Create a Payment SourceAPI Retrieve a Payment SourceAPI Get List of Payment SourcesAPI	-
billing.price:read	Retrieve a PriceAPI Get list of PricesAPI	-
billing.price:write	Create a PriceAPI Retrieve a PriceAPI Update a PriceAPI Get list of PricesAPI	-
billing.product:read	Retrieve a ProductAPI Get list of ProductsAPI	-
billing.product:write	Create a ProductAPI Retrieve a ProductAPI Update a ProductAPI Get list of ProductsAPI	-
billing.subscription:read	Retrieve a SubscriptionAPI Get list of SubscriptionsAPI Retrieve a Subscription ItemAPI Get list of Subscription ItemsAPI	subscription.active subscription.cancelled subscription.created subscription.in_trial subscription.modified subscription.unpaid subscription.updated
billing.subscription:write	Create a SubscriptionAPI Retrieve a SubscriptionAPI Update a SubscriptionAPI Cancel a SubscriptionAPI Get list of SubscriptionsAPI Retrieve a Subscription ItemAPI Get list of Subscription ItemsAPI	subscription.active subscription.cancelled subscription.created subscription.in_trial subscription.modified subscription.unpaid subscription.updated
billing.usage_metering:read	Retrieve a MeterAPI Get list of MetersAPI Get summaries of a MeterAPI	-
billing.usage_metering:write	Create a MeterAPI Retrieve a MeterAPI Update a MeterAPI Archive a MeterAPI Restore a MeterAPI Get list of MetersAPI Get summaries of a MeterAPI Ingest a Usage EventAPI Batch Ingest Usage EventsAPI Void a Usage EventAPI	usage_event.aggregation_failed

Business Accounts

Scope	APIs	Webhook events
balance:read	Get current balancesAPI Get balance historyAPI	balance.va.top_up balance.ga.top_up balance.adjustment
global_account:read	Get a list of global accountsAPI Get a List of Direct Debit Payout MandatesAPI Get a Direct Debit Payout Mandate by IDAPI Get global account by IDAPI Generate global account statementAPI Get global account transactionsAPI	ga.new
global_account:write	Get a list of global accountsAPI Create a global accountAPI Get a List of Direct Debit Payout MandatesAPI Get a Direct Debit Payout Mandate by IDAPI Cancel a Direct Debit Payout Mandate by IDAPI Get global account by IDAPI Close a global accountAPI Generate global account statementAPI Get global account transactionsAPI Update existing global accountAPI	ga.new

Cards

Scope	APIs	Webhook events
issuing.card:read	Get all cardsAPI Get card remaining limitsAPI Get issuing configAPI Get card detailsAPI Get sensitive card detailsAPI	issuing.card_notification.created issuing.card_notification.physical_activated issuing.card.modified issuing.card.pending issuing.card.failed issuing.card.inactive issuing.card.active issuing.card.lost issuing.card.stolen issuing.card.closed issuing.card.blocked issuing.card.expired issuing.card.low_remaining_transaction_limit
issuing.card:write	Create a cardAPI Update a cardAPI Activate a cardAPI	-
issuing.cardholder:read	Get all cardholdersAPI Get cardholder detailsAPI	issuing.cardholder.deleted issuing.cardholder.disabled issuing.cardholder.incomplete issuing.cardholder.pending issuing.cardholder.ready
issuing.cardholder:write	Create a cardholderAPI Update a cardholderAPI Delete cardholderAPI	-
issuing.transaction:read	Get transactionsAPI Get single transactionAPI Get authorization statusAPI Get single authorization statusAPI Get card transactionsAPI Get single card transactionAPI Get card transaction eventsAPI Get single card transaction eventAPI Get card transaction lifecyclesAPI Get single card transaction lifecycleAPI	issuing.transaction.succeeded issuing.transaction.failed
issuing.merchant_brand:read	Get single Merchant Brand by idAPI Get all Merchant Brands matching queryAPI	-

Finance

Scope	APIs	Webhook events
financial_report:read	Get list of financial reportsAPI Get financial report by IDAPI Get contents of a financial reportAPI	-
financial_report:write	Get list of financial reportsAPI Create a financial reportAPI Get financial report by IDAPI Get contents of a financial reportAPI	-
financial_transaction:read	Get list of financial transactionsAPI Get a financial transaction by IDAPI	-

Payments

Scope	APIs	Webhook events
payment_link:read	Retrieve a PaymentLinkAPI Get list of PaymentLinksAPI	-
payment_link:write	Retrieve a PaymentLinkAPI Get list of PaymentLinksAPI Create a PaymentLinkAPI Update a PaymentLinkAPI Send a PaymentLinkAPI Activate a PaymentLinkAPI Deactivate a PaymentLinkAPI	-
payment_acceptance:read	Get list of PaymentIntentsAPI Retrieve a PaymentIntentAPI Retrieve list of PaymentAttemptsAPI Retrieve a PaymentAttempt by IDAPI Get list of settlementsAPI Get a settlement by IDAPI Get a settlement report by IDAPI Get list of RefundsAPI Retrieve a RefundAPI Get available bank namesAPI Get available payment method typesAPI Get list of PaymentConsentsAPI Retrieve a PaymentConsentAPI Get list of PaymentMethodsAPI Retrieve a PaymentMethodAPI Get list of CustomersAPI Retrieve a CustomerAPI Generate a client secret for a CustomerAPI Get list of PaymentLinksAPI Retrieve a PaymentLinkAPI Get convertible shopper currenciesAPI Get Apple Pay DomainsAPI Retrieve a Conversion QuoteAPI Retrieve BIN InfoAPI	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_intent.payment_failed 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 PaymentIntentAPI Cancel a PaymentIntentAPI Capture a PaymentIntentAPI Confirm a PaymentIntentAPI Continue to confirm a PaymentIntentAPI Create a RefundAPI Add PaymentMethod to CustomerAPI Remove PaymentMethod from CustomerAPI Update a CustomerAPI Create a CustomerAPI Disable a PaymentConsentAPI Update a PaymentConsentAPI Verify a PaymentConsentAPI Create a PaymentConsentAPI Continue to verify a PaymentConsentAPI Update a PaymentIntentAPI Increment Authorization for a PaymentIntentAPI Create a PaymentLinkAPI Update a PaymentLinkAPI Send a PaymentLinkAPI Activate a PaymentLinkAPI Deactivate a PaymentLinkAPI Create a Conversion QuoteAPI Add Apple Pay DomainsAPI Remove Apple Pay DomainsAPI	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_intent.payment_failed 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 PaymentDisputeAPI Get list of PaymentDisputesAPI Get list of Related Payment IntentsAPI	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 PaymentDisputeAPI Challenge a PaymentDisputeAPI Retrieve a PaymentDisputeAPI Get list of PaymentDisputesAPI Get list of Related Payment IntentsAPI	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 TerminalAPI Get list of TerminalsAPI	-
pos_terminal:write	Create a TerminalAPI Activate a TerminalAPI Deactivate a TerminalAPI Terminate a TerminalAPI Update a TerminalAPI Reset a Terminal passwordAPI Process a PaymentIntent in a TerminalAPI	-
funds_split:write	Create a FundsSplitReversalAPI Create a FundsSplitAPI Release a FundsSplitAPI	-
funds_split:read	Retrieve a FundsSplitReversalAPI Get list of FundsSplitReversalsAPI Retrieve a FundsSplitAPI Get list of FundsSplitsAPI	funds_split.created funds_split.failed funds_split.released funds_split.settled

Payouts

Scope	APIs	Webhook events
beneficiary:read	Get list of beneficiariesAPI Get a beneficiary by IDAPI	-
beneficiary:write	Get list of beneficiariesAPI Get a beneficiary by IDAPI Create a new beneficiaryAPI Delete existing beneficiaryAPI Update existing beneficiaryAPI Validate beneficiaryAPI Get the API schemaAPI Get the form schemaAPI Get supported financial institutionsAPI	-
transfer:read	Get list of transfersAPI Get transfer by IDAPI Supported currenciesAPI Retrieve a current rateAPI Get list of wallet transfersAPI Get a wallet transfer with transfer IDAPI List all batch transfersAPI Retrieve a batch transferAPI List all items within a batchAPI	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 transfersAPI Get transfer by IDAPI Cancel a transferAPI Confirm funding for a transferAPI Create a new transferAPI Validate transferAPI Supported currenciesAPI Retrieve a current rateAPI Get list of wallet transfersAPI Get a wallet transfer with transfer IDAPI Create a new wallet transferAPI List all batch transfersAPI Retrieve a batch transferAPI List all items within a batchAPI Create a batch transferAPI Add items to a batchAPI Delete a batch transferAPI Delete items within a batchAPI Quote a batch transferAPI Submit a batch transferAPI	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

Risk

Scope	APIs	Webhook events
risk.rfi:read	List all RFIsAPI Retrieve an RFIAPI	rfi.action_required rfi.answered rfi.closed
risk.rfi:write	List all RFIsAPI Retrieve an RFIAPI Respond to an RFIAPI	rfi.action_required rfi.answered rfi.closed

Simulations

Scope	APIs	Webhook events
simulation:write	AccountsAPI BillingAPI DepositsAPI IssuingAPI Linked AccountsAPI Payment AcceptanceAPI Request for Information (RFI)API TransfersAPI	-

Spend

Scope	APIs	Webhook events
spend.bill:read	List billsAPI Get billAPI	spend.bill.awaiting_approval spend.bill.updated spend.bill.awaiting_payment spend.bill.payment_in_progress spend.bill.paid spend.bill.rejected spend.bill.scheduled spend.bill.deleted
spend.bill:write	Create billAPI Update bill sync statusAPI Mark bill as paidAPI	-
spend.expense:read	List expensesAPI Get expenseAPI List reimbursement reportsAPI Get reimbursement reportAPI List reimbursementsAPI Get reimbursementAPI Get reimbursement report transferAPI	spend.expense.draft spend.expense.awaiting_approval spend.expense.updated spend.expense.rejected spend.expense.approved spend.expense.archived spend.expense.deleted spend.reimbursement_report.draft spend.reimbursement_report.awaiting_approval spend.reimbursement_report.awaiting_payment spend.reimbursement_report.rejected spend.reimbursement_report.payment_in_progress spend.reimbursement_report.paid spend.reimbursement_report.mark_as_paid spend.reimbursement_report.deleted spend.reimbursement_report.updated
spend.expense:write	Update expense sync statusAPI Update reimbursement report transfer sync statusAPI Update reimbursement report sync statusAPI Mark reimbursement report as paidAPI	-
spend.purchase_order:read	List purchase ordersAPI Get purchase orderAPI	-
spend.purchase_order:write	Create purchase orderAPI Update purchase order sync statusAPI	-
spend.vendor:read	List vendorsAPI Get vendorAPI	-
spend.vendor:write	Create vendorAPI Update vendor sync statusAPI	-

Supporting Services

Scope	APIs	Webhook events
reference.order_item:read	Get expiring transfer or deposit limitAPI Get transfer or deposit limitAPI	-
reference.order_item:write	Increase transfer or deposit limitAPI	-
commerce_store:read	Get a list of e-commerce storesAPI Get an e-commerce store by idAPI	-
file:upload	Upload a fileAPI	-

Transactional FX

Scope	APIs	Webhook events
fx.conversion:read	Retrieve a conversionAPI List all conversionsAPI Retrieve an amendmentAPI List all amendmentsAPI Retrieve a quoteAPI Retrieve a current rateAPI	conversion.scheduled conversion.overdue conversion.settled conversion.cancelled
fx.conversion:write	Retrieve a conversionAPI List all conversionsAPI Create a conversionAPI Create an amendment quoteAPI Create an amendmentAPI Retrieve an amendmentAPI List all amendmentsAPI Retrieve a quoteAPI Create a quoteAPI Retrieve a current rateAPI	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
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

Was this page helpful?