API key scopes

Copy for LLMView as Markdown

A scoped API key is an API credential for your Airwallex account that grants Read or Write access to the resource areas you select, instead of full account access. Each scope controls which REST endpoints the key can call and which webhook events you can subscribe to when using that key, so you can give each integration only the access it needs.

The tables below list every scope available when you create or edit a key. Use them to plan integrations, document access for your team, or look up what a scope enables when you configure keys in the Airwallex web app .

Scopes reference

Scopes are grouped by product. For each scope, the table shows its label, authorized REST operations for Read and Write access, and webhook events. A dash means no APIs or events apply for that column.

Account Capabilities

Resource	Read	Write	Webhook events
Account Capabilities	Get funding limits API Get capability by ID API	Get funding limits API Get capability by ID API Enable a capability API	account_capability.disabled account_capability.enabled account_capability.pending seller.active seller.in_review seller.inactive seller.pending_deactivation seller.rejected seller.suspended

Billing

Resource	Read	Write	Webhook events
Billing Checkouts	Retrieve a Billing Checkout API Get list of Billing Checkouts API	Create a Billing Checkout API Retrieve a Billing Checkout API Get list of Billing Checkouts API Update a Billing Checkout API Cancel a Billing Checkout API	billing_checkout.cancelled billing_checkout.completed billing_checkout.created
Billing Customers	Retrieve a Billing Customer API Get list of Billing Customers API	Create a Billing Customer API Retrieve a Billing Customer API Update a Billing Customer API Get list of Billing Customers API	-
Billing Transactions	Retrieve a Billing Transaction API Get list of Billing Transactions API	-	billing_transaction.cancelled billing_transaction.created billing_transaction.succeeded
Credit Notes	Retrieve a Credit Note API Get list of Credit Notes API Retrieve a Credit Note Line Item API Get list of Credit Note Line Items API	Create a Credit Note API Retrieve a Credit Note API Get list of Credit Notes API Update a Credit Note API Finalize a Credit Note API Delete a Credit Note API Void a Credit Note API Create Credit Note Line Items and add them to a Credit Note API Retrieve a Credit Note Line Item API Get list of Credit Note Line Items API Update Credit Note Line Items in a Credit Note API Delete Credit Note Line Items from a Credit Note API	credit_note.created credit_note.finalized credit_note.voided
Discounts	Retrieve a Coupon API Get list of Coupons API	Create a Coupon API Update a Coupon API Retrieve a Coupon API Get list of Coupons API	-
Invoices	Retrieve an Invoice API Get list of Invoices API Retrieve an Invoice Line Item API Get list of Invoice Line Items API	Create an Invoice API Preview an Invoice API Update an Invoice API Delete a draft Invoice API Retrieve an Invoice API Get list of Invoices API Finalize an Invoice API Mark an Invoice as paid API Void an Invoice API Create Invoice Line Items and add them to an Invoice API Retrieve an Invoice Line Item API Get list of Invoice Line Items API Update Invoice Line Items in an Invoice API Delete Invoice Line Items within an Invoice API	invoice.created invoice.finalized invoice.paid invoice.payment.paid invoice.payment_attempt_failed invoice.payment_failed invoice.sent invoice.voided
Payment Sources	Retrieve a Payment Source API Get List of Payment Sources API	Create a Payment Source API Retrieve a Payment Source API Get List of Payment Sources API	-
Prices	Retrieve a Price API Get list of Prices API	Create a Price API Retrieve a Price API Update a Price API Get list of Prices API	-
Products	Retrieve a Product API Get list of Products API	Create a Product API Retrieve a Product API Update a Product API Get list of Products API	-
Subscriptions	Retrieve a Subscription API Get list of Subscriptions API Retrieve a Subscription Item API Get list of Subscription Items API	Create a Subscription API Retrieve a Subscription API Update a Subscription API Cancel a Subscription API Get list of Subscriptions API Retrieve a Subscription Item API Get list of Subscription Items API	subscription.active subscription.cancelled subscription.created subscription.in_trial subscription.modified subscription.unpaid subscription.updated
Usage Metering	Retrieve a Meter API Get list of Meters API Get summaries of a Meter API	Create a Meter API Retrieve a Meter API Update a Meter API Archive a Meter API Restore a Meter API Get list of Meters API Get summaries of a Meter API Ingest a Usage Event API Batch Ingest Usage Events API Void a Usage Event API	usage_event.aggregation_failed (requires Write scope)

Core Resources

Resource	Read	Write	Webhook events
Balances	Get current balances API Get balance history API	-	-
Deposits	Get a list of deposits API Get a deposit by ID API	Get a list of deposits API Create a deposit via Direct Debit API Get a deposit by ID API	-
Direct Debits	Get list of direct debits API Get direct debit by ID API	Get list of direct debits API Get direct debit by ID API Cancel a direct debit by ID API	direct_debit.created direct_debit.in_review direct_debit.pending direct_debit.rejected direct_debit.returned direct_debit.settled
Global Accounts	Get current balances API Get balance history API Get a list of global accounts API Get a List of Direct Debit Payout Mandates API Get a Direct Debit Payout Mandate by ID API Get global account by ID API Get global account transactions API	Get current balances API Get balance history API Get a list of global accounts API Create a global account API Get a List of Direct Debit Payout Mandates API Get a Direct Debit Payout Mandate by ID API Cancel a Direct Debit Payout Mandate by ID API Get global account by ID API Close a global account API Generate global account statement API Get global account transactions API Update existing global account API	global_account.active global_account.closed global_account.failed
Linked Accounts	Get a list of Linked Accounts API Get a Linked Account by ID API Get a Direct Debit Deposit Mandate API Check available balances API	Get a list of Linked Accounts API Get a Linked Account by ID API Generate a Linked Account authentication API Create a Linked Account API Refresh a Linked Account authentication API Complete the authentication refresh API Verify Linked Account with micro-deposits API Get a Direct Debit Deposit Mandate API Update a Direct Debit Deposit Mandate API Check available balances API Suspend a Linked Account API Confirm a Linked Account among candidate accounts API	deposit.pending deposit.rejected deposit.reversed deposit.settled linked_account.failed linked_account.processing linked_account.requires_action linked_account.succeeded linked_account.suspended

Finance

Resource	Read	Write	Webhook events
Financial Reports	Get list of financial reports API Create a financial report API Get financial report by ID API Get contents of a financial report API	-	-
Financial Transactions	Get list of financial transactions API Get a financial transaction by ID API	-	-

Issuing

Resource	Read	Write	Webhook events
Authorizations and Transactions	Get authorization status API Get single authorization status API Get card transaction events API Get single card transaction event API Get card transaction lifecycles API Get single card transaction lifecycle API Get card transactions API Get single card transaction API Get transactions API Get single transaction API	-	-
Cardholders	Get all cardholders API Get cardholder details API	Create a cardholder API Update a cardholder API Delete cardholder API	issuing.cardholder.deleted issuing.cardholder.disabled issuing.cardholder.incomplete issuing.cardholder.pending issuing.cardholder.ready
Cards	Get sensitive card details API Get all cards API Get card details API Get card remaining limits API	Create a card API Activate a card API Update a card API	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
Config	Get issuing config API	Update issuing config API	-
Digital Wallet Tokens	Get single digital wallet token API Get all digital wallet tokens API	-	issuing.digital_wallet_notification.abandoned_provisioning issuing.digital_wallet_notification.payment_reminder issuing.digital_wallet_notification.token_activated issuing.digital_wallet_notification.token_provisioning_otp issuing.digital_wallet_notification.wallet_available issuing.digital_wallet_token.created issuing.digital_wallet_token.provision_attempted issuing.digital_wallet_token.updated
Merchant Brands	Get single Merchant Brand by id API Get all Merchant Brands matching query API	-	-
Transaction Disputes	Get a transaction dispute API Get all transaction disputes API	Create a transaction dispute API Update a transaction dispute API Submit a transaction dispute API Cancel a transaction dispute API	issuing.transaction_dispute.accepted issuing.transaction_dispute.cancelled issuing.transaction_dispute.created issuing.transaction_dispute.expired issuing.transaction_dispute.lost issuing.transaction_dispute.modified issuing.transaction_dispute.rejected issuing.transaction_dispute.submitted issuing.transaction_dispute.won

Payment Acceptance

Resource	Read	Write	Webhook events
Funds Splits	Retrieve a FundsSplitReversal API Get list of FundsSplitReversals API Retrieve a FundsSplit API Get list of FundsSplits API	Create a FundsSplitReversal API Create a FundsSplit API Release a FundsSplit API	funds_split.created funds_split.failed funds_split.released funds_split.settled
Payment Acceptance	Get list of settlements API Get a settlement by ID API Get a settlement report by ID API Get Apple Pay Domains API Get convertible shopper currencies API Retrieve a Conversion Quote API Retrieve a Customer API Generate a client secret for a Customer API Get list of Customers API Retrieve a PaymentAttempt by ID API Retrieve list of PaymentAttempts API Retrieve a PaymentConsent API Get list of PaymentConsents API Retrieve a PaymentIntent API Get list of PaymentIntents API Retrieve a PaymentLink API Get list of PaymentLinks API Retrieve a PaymentMethod API Get list of PaymentMethods API Retrieve BIN Info API Retrieve a Refund API Get list of Refunds API	Add Apple Pay Domains API Remove Apple Pay Domains API Create a Conversion Quote API Create a Customer API Update a Customer API Create a PaymentConsent API Update a PaymentConsent API Verify a PaymentConsent API Continue to verify a PaymentConsent API Disable a PaymentConsent API Create a PaymentIntent API Update a PaymentIntent API Confirm a PaymentIntent API Continue to confirm a PaymentIntent API Increment Authorization for a PaymentIntent API Capture a PaymentIntent API Cancel a PaymentIntent API Create a PaymentLink API Update a PaymentLink API Send a PaymentLink API Activate a PaymentLink API Deactivate a PaymentLink API Create a Refund API	customer.created customer.creation_failed customer.update_failed customer.updated payment_attempt.authentication_failed payment_attempt.authentication_redirected payment_attempt.authorization_voided payment_attempt.authorized payment_attempt.cancelled payment_attempt.capture_failed payment_attempt.capture_requested payment_attempt.captured payment_attempt.expired payment_attempt.failed payment_attempt.failed_to_process payment_attempt.paid payment_attempt.payment_code_generated payment_attempt.payment_code_generation_failed payment_attempt.pending_authorization payment_attempt.received payment_attempt.risk_declined payment_attempt.settled payment_attempt.succeeded payment_consent.created payment_consent.disabled payment_consent.paused payment_consent.pending payment_consent.requires_customer_action payment_consent.requires_payment_method payment_consent.updated payment_consent.verification_failed payment_consent.verified payment_intent.cancelled payment_intent.capture_required payment_intent.created payment_intent.customer_action_required payment_intent.merchant_action_required payment_intent.payment_method_required payment_intent.pending payment_intent.requires_capture payment_intent.requires_customer_action payment_intent.requires_payment_method payment_intent.succeeded payment_intent.updated refund.accepted refund.failed refund.processing refund.received refund.settled refund.succeeded
Payment Disputes	Retrieve a PaymentDispute API Get list of PaymentDisputes API Get list of Related Payment Intents API	Retrieve a PaymentDispute API Get list of PaymentDisputes API Accept a PaymentDispute API Challenge a PaymentDispute API Get list of Related Payment Intents API	dispute.accepted dispute.arbitration_escalate_received_by_merchant dispute.dispute_received_by_merchant dispute.dispute_responded_by_merchant dispute.dispute_reversed dispute.lost dispute.pre_arbitration_received_by_merchant dispute.pre_chargeback_accepted dispute.pre_chargeback_received_by_merchant dispute.rfi_received_by_merchant dispute.rfi_responded_by_merchant dispute.won payment_dispute.accepted payment_dispute.challenged payment_dispute.expired payment_dispute.lost payment_dispute.pending_closure payment_dispute.pending_decision payment_dispute.requires_response payment_dispute.reversed payment_dispute.won payment_method.attached payment_method.attachment_failed payment_method.created payment_method.creation_failed payment_method.detached payment_method.detachment_failed payment_method.disable_failed payment_method.disabled payment_method.updated
Payment Links	Retrieve a PaymentLink API Get list of PaymentLinks API	Create a PaymentLink API Update a PaymentLink API Retrieve a PaymentLink API Send a PaymentLink API Activate a PaymentLink API Deactivate a PaymentLink API Get list of PaymentLinks API	payment_link.created payment_link.paid
POS Terminals	Retrieve a Terminal API Get list of Terminals API	Create a Terminal API Process a PaymentIntent in a Terminal API Activate a Terminal API Deactivate a Terminal API Terminate a Terminal API Update a Terminal API Reset a Terminal password API	pos.terminal.activated pos.terminal.admin_password_status.activated pos.terminal.admin_password_status.locked pos.terminal.admin_password_status.reset_requested pos.terminal.deactivated pos.terminal.refund_password_status.activated pos.terminal.refund_password_status.locked pos.terminal.refund_password_status.opted_out pos.terminal.refund_password_status.reset_requested pos.terminal.terminated pos.terminal.updated

Payouts

Resource	Read	Write	Webhook events
Beneficiaries	Get list of beneficiaries API Get a beneficiary by ID API	Get list of beneficiaries API Create a new beneficiary API Validate beneficiary API Get a beneficiary by ID API Delete existing beneficiary API Update existing beneficiary API Get the API schema API Get the form schema API Get supported financial institutions API	-
Transfers	List all batch transfers API Retrieve a batch transfer API List all items within a batch API Get list of transfers API Get transfer by ID API Supported currencies API	Create confirmation letter API List all batch transfers API Create a batch transfer API Retrieve a batch transfer API Add items to a batch API Delete a batch transfer API Delete items within a batch API List all items within a batch API Quote a batch transfer API Submit a batch transfer API Get list of transfers API Create a new transfer API Validate transfer API Get transfer by ID API Cancel a transfer API Confirm funding for a transfer API Supported currencies API	connected_account_transfer.failed connected_account_transfer.new connected_account_transfer.pending connected_account_transfer.settled connected_account_transfer.suspended transfer.failed transfer.new transfer.pending transfer.settled transfer.suspended

Risk

Resource	Read	Write	Webhook events
Request for Information (RFI)	List all RFIs API Retrieve an RFI API	List all RFIs API Retrieve an RFI API Respond to an RFI API	rfi.action_required rfi.answered rfi.closed

Connected Accounts

Resource	Read	Write	Webhook events
Account	Retrieve account details API	-	-
Charges	Get list of charges API Get a charge by ID API	Create a new charge API	charge.failed charge.new charge.pending charge.settled charge.suspended
Connected Accounts	Get account by ID API Get list of connected accounts API	Create an account API Update a connected account API Submit account for activation API Agree to terms and conditions API Suspend account API Reactivate account API	account.action_required account.active account.connected account.submitted account.suspended
Hosted Flows	Get flow API	Create flow API Authorize flow API	-
Invitation Links	Get an account invitation link by ID API	Create an account invitation link API	-
Platform Reports	Get Platform report API	Create Platform report API	platform_report.completed platform_report.failed
PSP Settlement Deposits	Get a list of PSP settlement deposits API	-	psp_settlement_deposit.new psp_settlement_deposit.action_required psp_settlement_deposit.matched psp_settlement_deposit.settled
PSP Settlement Intents	Get a PSP settlement intent by ID API Get a list of PSP settlement intents API	Get a PSP settlement intent by ID API Get a list of PSP settlement intents API Create a new PSP settlement intent API Update a PSP settlement intent API Cancel a PSP settlement intent by ID API Submit a PSP settlement intent by ID API Split a PSP settlement intent API	psp_settlement_intent.new psp_settlement_intent.cancelled psp_settlement_intent.submitted psp_settlement_intent.action_required psp_settlement_intent.matched psp_settlement_intent.settled
PSP Settlement Splits	Get a PSP settlement split by ID API Get list of PSP settlement splits API	Get a PSP settlement split by ID API Get list of PSP settlement splits API Release a PSP settlement split by ID API Cancel a PSP settlement split by ID API	psp_settlement_split.new psp_settlement_split.create_failed psp_settlement_split.cancelled psp_settlement_split.matched psp_settlement_split.pending psp_settlement_split.failed psp_settlement_split.settled
Transfers	Get list of connected account transfers API Get a connected account transfer by ID API	Create a new connected account transfer API	connected_account_transfer.failed connected_account_transfer.new connected_account_transfer.pending connected_account_transfer.settled connected_account_transfer.suspended transfer.failed transfer.new transfer.pending transfer.settled transfer.suspended

Simulations

Resource	Read	Write	Webhook events
Simulations	-	Accounts API Billing API Deposits API Issuing API Linked Accounts API Payment Acceptance API Payouts API Request for Information (RFI) API Transfers API	-

Spend

Resource	Read	Write	Webhook events
Bills	List bills API Get bill API	Update bill sync status API	-
Expenses	List expenses API Get expense API List reimbursement reports API Get reimbursement report API List reimbursements API Get reimbursement API Get reimbursement report transfer API	Update expense sync status API Update reimbursement report transfer sync status API Update reimbursement report sync status API Mark reimbursement report as paid API	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
Purchase Orders	List purchase orders API Get purchase order API	Create purchase order API Update purchase order sync status API	-
Vendors	List vendors API Get vendor API	Create vendor API Update vendor sync status API	-

Supporting Services

Resource	Read	Write	Webhook events
Upload Files	-	Upload a file API	-

Transactional FX

Resource	Read	Write	Webhook events
Conversion	Get current balances API Get balance history API 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	Get current balances API Get balance history API Create a conversion API Retrieve a conversion API List all conversions API Create an amendment quote API Create an amendment API Retrieve an amendment API List all amendments API Create a quote API Retrieve a quote API Retrieve a current rate API	-

Was this page helpful?