Airwallex
API integration

airwallex_account_capabilities_enable

Enable a specific capability for your Airwallex account by submitting an enable request. Returns: comment, details, entity_type, id, status, updated_at. Required: account_capability_id and id. Body varies by capability — payment methods accept enroll_sme_program; transfer_cny_local requires entity_type plus declarant details.

get_single_airwallex_account_capability_by_id

Get the status of a single Airwallex account capability by its unique identifier. Returns the capability's id, status, entity_type, comment, details (including reason_codes), and updated_at. Required: id.

list_all_airwallex_account_capabilities_funding_limits

List Airwallex funding limits, e.g. the available funding limit or Faster Direct Debit limit before initiating a Direct Debit from a Linked Account or Funding Source. Returns: has_more, items. Filter by ccy, effective_at, or mandate_type.

list_all_airwallex_accounting_gl_accounts

List all General Ledger (GL) accounts used in Airwallex Spend, filterable by status, external_id, or legal_entity_id. Returns: id, code, value, value_label, external_id, legal_entity_ids, status, created_at, updated_at. Max 100 per page.

get_single_airwallex_accounting_gl_account_by_id

Get a single General Ledger (GL) account by id. Returns: id, code, value, value_label, external_id, legal_entity_ids, status, created_at, updated_at. Required: id.

create_a_airwallex_accounting_gl_account

Create a General Ledger (GL) account for coding Airwallex Spend transactions. Returns the created account with id, code, value, value_label, legal_entity_ids, status, created_at, updated_at. Required: request_id, value.

update_a_airwallex_accounting_gl_account_by_id

Update an existing General Ledger (GL) account by id. Returns the updated account with id, code, value, value_label, legal_entity_ids, status, created_at, updated_at. Required: id, value, status.

list_all_airwallex_accounting_tax_codes

List Airwallex tax codes used in Airwallex Spend, filtered by status, external ID, or legal entity. Returns each tax code's id, value, rate_percent, value_label, external_id, legal_entity_ids, status, created_at, and updated_at.

get_single_airwallex_accounting_tax_code_by_id

Get a single Airwallex tax code used in Airwallex Spend by id. Returns the tax code including id, value, rate_percent, value_label, external_id, legal_entity_ids, status, created_at, and updated_at. Required: id.

create_a_airwallex_accounting_tax_code

Create a new Airwallex tax code for coding Airwallex Spend transactions. Returns the created tax code including id, value, rate_percent, external_id, legal_entity_ids, and status. Requires request_id, value, and rate_percent.

update_a_airwallex_accounting_tax_code_by_id

Update an existing Airwallex tax code used in Airwallex Spend by id. Returns the updated tax code including id, value, rate_percent, external_id, legal_entity_ids, and status. Requires id, value, rate_percent, and status.

create_a_airwallex_authentication_authorize

Authorize the Airwallex platform, or a connected account, to use embedded components such as onboarding, payouts, KYB, RFI, SCA, and tax forms, requesting access via a list of scopes. Returns: authorization_code. Required: code_challenge, scope.

create_a_airwallex_authentication_login

Exchange your Airwallex API key and client ID for a bearer access token to use when calling other Airwallex endpoints. Returns: expires_at, token. The access token is valid for 30 minutes and can be reused until it expires.

airwallex_billing_billing_checkouts_cancel

Cancel a Billing Checkout in Airwallex by id. Only checkouts in ACTIVE status can be cancelled; afterwards the customer can no longer complete the checkout. Returns the updated checkout including id, status, cancelled_at, mode, currency, line_items, and url. Required: id.

list_all_airwallex_billing_billing_checkouts

List all Billing Checkouts in Airwallex, filterable by subscription_id, from_created_at, to_created_at, and status. Returns each checkout with id, status, mode, currency, line_items, created_at, and url. Default 20 per page, max 1000.

get_single_airwallex_billing_billing_checkout_by_id

Get a single Airwallex Billing Checkout by id. Returns the checkout object including id, status, mode, currency, line_items, subscription_id, created_at, and url. Required: id.

create_a_airwallex_billing_billing_checkout

Create a Billing Checkout in Airwallex to collect payments, set up subscriptions, or save payment details for later. Returns the created checkout including id, status, url, client_secret, currency, and line_items. Requires mode and request_id.

update_a_airwallex_billing_billing_checkout_by_id

Update an Airwallex Billing Checkout by id. Currently supports updating the checkout's metadata. Returns the updated checkout including id, status, mode, currency, metadata, and url. Required: id.

list_all_airwallex_billing_credit_notes

List Airwallex billing credit notes, filterable by invoice_id, billing_customer_id, type, status, and a created_at date range. Returns credit note objects including id, number, status, type, total_amount, and created_at.

get_single_airwallex_billing_credit_note_by_id

Get a single Airwallex billing credit note by id. Returns the full credit note object including id, number, status, type, total_amount, currency, and pdf_url. Required: id.

airwallex_billing_credit_notes_add_line_items

Add line items to a draft Airwallex billing credit note. Returns the updated credit note including id, status, total_amount, and updated_at. Required: credit_note_id, line_items, request_id. Max 100 line items per request; the bulk add is atomic.

create_a_airwallex_billing_credit_note

Create an Airwallex billing credit note linked to an invoice. Returns the created credit note including id, number, status, total_amount, and type. Required: invoice_id, reason, request_id, type.

delete_a_airwallex_billing_credit_note_by_id

Delete a draft Airwallex billing credit note by id. Returns: deleted, id. Required: id.

airwallex_billing_credit_notes_delete_line_items

Delete line items from an Airwallex credit note. Returns the updated credit note including id, number, status, total_amount, and refund_status. Required: credit_note_id, line_item_ids. Only possible while the credit note status is DRAFT; max 100 line items per request and the bulk delete is atomic.

airwallex_billing_credit_notes_finalize

Finalize a draft Airwallex credit note. Returns the finalized credit note including id, status, finalized_at, total_amount, and refund_status. Required: credit_note_id. For AFTER_PAYMENT credit notes, allocate the total_amount via refund_amount or out_of_band_amount.

airwallex_billing_credit_notes_preview

Preview an Airwallex credit note linked to an invoice before issuing it. Returns the preview including adjustment_amount, line_items, total_amount, total_discount_amounts, and total_tax_amount. Required: invoice_id, line_items, reason, type.

update_a_airwallex_billing_credit_note_by_id

Update a draft credit note in Airwallex by its id. Returns the updated credit note object including id, number, status, total_amount, reason, memo, and metadata. Required: id.

airwallex_billing_credit_notes_update_line_items

Update up to 100 line items on an Airwallex credit note by credit_note_id; only possible while the credit note status is DRAFT, and the bulk update is atomic (all updates succeed or fail together). Returns the updated credit note object including id, number, status, total_amount, and memo. Required: credit_note_id, line_items.

airwallex_billing_credit_notes_void

Void a finalized Credit Note in Airwallex, transitioning it from finalized to voided — allowed only when the credit note type is pre-payment and the linked invoice's payment status is unpaid. Returns the updated credit note including id, number, status, reason, total_amount, and voided_at. Required: credit_note_id.

list_all_airwallex_credit_note_line_items

List all line items of an Airwallex credit note. Returns each line item's id, amount, currency, quantity, unit_amount, tax_amount, tax_breakdown, discount_amounts, price_tier, and created_at. Required: credit_note_id and id.

get_single_airwallex_credit_note_line_item_by_id

Get a single Airwallex credit note line item. Returns the line item object including its id, amount, currency, quantity, unit_amount, tax_amount, tax_percent, price_tier, discount_amounts, and tax_breakdown. Required: credit_note_id, id.

list_all_airwallex_billing_billing_customers

List all Airwallex Billing Customers based on the query parameters. Returns: items, page_after, page_before. Filterable by from_created_at, to_created_at, and email.

get_single_airwallex_billing_billing_customer_by_id

Get a single Airwallex Billing Customer by id. Returns: address, automatic_tax_eligibility, created_at, default_billing_currency, default_legal_entity_id, description, email, id, metadata, name, nickname, phone_number, tax_identification_number, type, updated_at. Required: id.

list_all_airwallex_billing_customer_bank_transfer_instructions

List bank transfer instructions for an Airwallex billing customer. Returns one read-only entry per supported currency with account_name, account_number, bank_name, and currency. The list is empty until instructions are provisioned. Required: billing_customer_id.

list_all_airwallex_billing_invoices

List all Airwallex billing invoices. Returns invoice records including id, number, status, payment_status, currency, total_amount, and amount_due.

get_single_airwallex_billing_invoice_by_id

Get an Airwallex billing invoice by id. Returns the full invoice object including id, number, status, payment_status, total_amount, due_at, and hosted_url. Required: id.

airwallex_billing_invoices_add_line_items

Add up to 100 line items to an Airwallex invoice in a single atomic operation; only possible while the invoice status is DRAFT. Returns the updated invoice including id, status, amount_due, and total_amount. Required: invoice_id, line_items, request_id.

create_a_airwallex_billing_invoice

Create a one-off Airwallex invoice. Returns the created invoice including id, number, status, payment_status, amount_due, and due_at. Required: billing_customer_id, currency, request_id.

delete_a_airwallex_billing_invoice_by_id

Delete a draft Airwallex invoice by id. Returns: deleted, id. Required: id.

airwallex_billing_invoices_delete_line_items

Delete up to 100 line items from an Airwallex invoice in one atomic bulk operation. Returns the updated invoice object including its id, number, status, amount_due, and updated_at. Only possible while the invoice status is DRAFT. Required: invoice_id, line_item_ids.

airwallex_billing_invoices_finalize

Finalize a draft Airwallex invoice so it becomes payable. Returns the finalized invoice object including its id, number, status, amount_due, due_at, payment_status, and bank_transfer_instructions. Required: invoice_id.

airwallex_billing_invoices_mark_as_paid

Mark a finalized Airwallex invoice as paid out-of-band. Returns the updated invoice object including its id, number, status, payment_status, paid_at, and paid_out_of_band. Required: invoice_id.

airwallex_billing_invoices_pay

Pay a finalized AUTO_CHARGE Airwallex invoice using an existing payment source. This is a one-time payment instruction and does not change the Payment Source saved on the Subscription. Returns the updated invoice including id, payment_status, status, amount_due, and total_amount. Required: invoice_id, payment_source_id.

airwallex_billing_invoices_preview

Preview an Airwallex invoice: the upcoming invoice for an existing subscription (pass subscription_id), or the first invoice before a new subscription is created (pass items instead). Returns: applied_discounts, automatic_tax_status, billing_customer_id, created_at, currency, default_tax_percent, enable_automatic_tax, items, legal_entity_id, subscription_id, total_amount, total_discount_amounts.

update_a_airwallex_billing_invoice_by_id

Update a draft Airwallex billing invoice by id. Only provided fields are changed, omitted fields remain unchanged, array fields are fully replaced, and a field can be cleared by setting it to null (or an empty string for strings). Returns the updated invoice: id, number, status, payment_status, amount_due, total_amount, and updated_at. Required: id.

airwallex_billing_invoices_update_line_items

Update existing line items on a draft Airwallex invoice in a single atomic bulk operation — only possible while the invoice status is DRAFT, up to 100 line items at a time. Returns the updated invoice: id, number, status, payment_status, amount_due, and updated_at. Required: invoice_id.

airwallex_billing_invoices_void

Void a finalized Airwallex invoice. Returns the voided invoice: id, number, status, payment_status, voided_at, and updated_at. Required: invoice_id.

list_all_airwallex_invoice_line_item_groups

List Airwallex line item groups for a specific invoice. Returns each group with id, invoice_id, label, period_starts_at, period_ends_at, and total amounts. Required: invoice_id.

get_single_airwallex_invoice_line_item_group_by_id

Get a single line item group on an Airwallex invoice by id. Returns the group's id, invoice_id, label, billing period (period_starts_at, period_ends_at), total_amount, total_quantity, total_tax_amount, total_discount_amount, and remaining creditable totals. Required: invoice_id and id (the line item group id).

list_all_airwallex_invoice_line_items

List all line items on an Airwallex invoice. Returns each line item with id, amount, currency, quantity, price, tax_amount, and period start/end times. Required: invoice_id.

get_single_airwallex_invoice_line_item_by_id

Get a single line item on an Airwallex invoice by id. Returns: amount, applied_discounts, created_at, currency, description, discount_amounts, id, invoice_id, label, line_item_group_id, metadata, period_ends_at, period_starts_at, price, quantity, price_tier, remaining_creditable_amount, remaining_creditable_quantity, tax_amount, tax_breakdown, tax_percent, updated_at. Required: id and invoice_id.

airwallex_billing_meters_archive

Archive an Airwallex billing meter so it can no longer be linked to new Prices. Returns the meter including id, name, event_name, aggregation_method, and archived. The meter can only be archived when it has no linked active price. Required: meter_id.

list_all_airwallex_billing_meters

List all Airwallex billing meters, filterable by archived status, event name, aggregation method and property, and created-at time range. Returns each meter's id, name, event_name, aggregation_method, archived, and created_at.

airwallex_billing_meters_restore

Restore an archived Airwallex billing meter so it becomes available to be linked to new Prices again. Returns the meter including id, name, event_name, aggregation_method, and archived. Required: meter_id.

get_single_airwallex_billing_meter_by_id

Get a single Airwallex billing meter by id. Returns the full meter object including id, name, event_name, aggregation_method, aggregation_property, archived, and created_at/updated_at timestamps. Required: id.

create_a_airwallex_billing_meter

Create an Airwallex billing meter that aggregates usage events by event name and aggregation method. Returns the created meter including id, name, event_name, aggregation_method, and archived. Requires name, event_name, aggregation_method, and request_id.

update_a_airwallex_billing_meter_by_id

Update an Airwallex billing meter. Returns the updated meter object including id, name, description, event_name, aggregation_method, archived, created_at, and updated_at. Required: meter_id.

list_all_airwallex_meter_summaries

List Airwallex usage summaries for a meter, calculating the meter's result for a billing customer over a given time period. Returns: items, page_after, page_before. Required: meter_id, billing_customer_id, from_happened_at, to_happened_at. Time range must not exceed one year.

airwallex_billing_subscriptions_cancel

Cancel a Subscription immediately in Airwallex with refunds applied according to the specified proration behavior. Returns the full Subscription record including id, status, cancel_requested_at, billing period bounds, and applied_discounts. Required: id (path), proration_behavior, request_id.

list_all_airwallex_billing_subscriptions

List all Airwallex Subscriptions with optional filters by Billing Customer, status, created-at range, and billing frequency. Returns each subscription with id, status, billing_customer_id, currency, collection_method, and period timestamps. Max 1000 per page (defaults to 20); pagination is handled automatically.

get_single_airwallex_billing_subscription_by_id

Get a single Airwallex Subscription by id. Returns the full subscription object including id, status, billing_customer_id, currency, collection_method, billing period bounds, and applied_discounts. Required: id.

create_a_airwallex_billing_subscription

Create a Subscription in Airwallex for an existing Billing Customer to charge the customer on a recurring basis. Returns the created subscription including id, status, collection_method, currency, and billing period timestamps. Required: billing_customer_id, collection_method, items, request_id.

update_a_airwallex_billing_subscription_by_id

Update an existing Airwallex Subscription; only fields provided in the request change, while omitted fields stay unchanged, and array fields are fully replaced when included. Returns the updated subscription including id, status, collection_method, currency, and billing period timestamps. Required: id (path), request_id.

list_all_airwallex_subscription_items

List all Subscription Items for an Airwallex subscription. Returns: items, page_after, page_before, examples. Required: subscription_id.

get_single_airwallex_subscription_item_by_id

Get a single Airwallex Subscription Item by id. Returns: applied_discounts, created_at, current_period_ends_at, current_period_starts_at, id, metadata, price, quantity, subscription_id, tax_percent, updated_at. Required: subscription_id and id.

list_all_airwallex_billing_billing_transactions

List Airwallex Billing Transactions associated with an invoice, optionally filtered by a created_at date range. Returns: amount, billing_customer_id, cancelled_at, created_at, currency, external_id, id, invoice_id, linked_payment_account_id, metadata, out_of_band, payment_source_id, status, succeeded_at, type, updated_at. Required: invoice_id. Max 1000 per page.

get_single_airwallex_billing_billing_transaction_by_id

Get a single Airwallex Billing Transaction by id. Returns: amount, billing_customer_id, cancelled_at, created_at, currency, external_id, id, invoice_id, linked_payment_account_id, metadata, out_of_band, payment_source_id, status, succeeded_at, type, updated_at. Required: id.

create_a_airwallex_confirmation_letters_create

Generate a confirmation letter in Airwallex for a deposit or payment transaction, returned as a binary file stream. Required: format and transaction_id.

list_all_airwallex_balances

List current Airwallex balances with available and pending amounts for every currency. Returns: account_type, available_amount, currency, pending_amount, prepayment_amount, reserved_amount, total_amount.

list_all_airwallex_balances_histories

List Airwallex balance history records for an account, where each record represents a change to the Wallet balance. Returns: has_more, items, page_after, page_before. Date range must be within 7 days when paginating with page_num.

list_all_airwallex_deposits

List all deposits made into your Airwallex wallet, optionally filtered by a created_at time period. Returns the paged results wrapper: has_more plus items, where each deposit includes id, amount, currency, status, created_at, settled_at, estimated_settled_at, fee, payer, failure_details, type, funding_source_id, global_account_id, provider_transaction_id, and reference. If from_created_at is…

get_single_airwallex_deposit_by_id

Retrieve a single Airwallex deposit by its unique id. Returns: amount, created_at, currency, estimated_settled_at, failure_details, fee, funding_source_id, global_account_id, id, payer, provider_transaction_id, reference, settled_at, status, type, examples. Required: id.

create_a_airwallex_deposit

Create a deposit into your Airwallex account via Direct Debit from a Linked Account (funding source). Returns the created deposit including id, amount, currency, status, created_at, settled_at, funding_source_id, fee, payer, and failure_details. Required: amount, currency, funding_source_id, request_id. deposit_type defaults to DIRECT_DEBIT if not specified.

airwallex_direct_debits_cancel

Cancel a Direct Debit in Airwallex by its transaction id. Returns a boolean result. Required: transaction_id.

list_all_airwallex_direct_debits

List Direct Debits in Airwallex, filtered by the created_at date range. If neither from_created_date nor to_created_date is provided, returns direct debits created within 30 days of today; if only to_created_date is provided, the 30 days before it. Returns each record's transaction_id, amount, currency, status, debtor_name, statement_ref, mandate_id, global_account_id, and created_at.

get_single_airwallex_direct_debit_by_id

Get a single Direct Debit in Airwallex by id. Returns the direct debit record with transaction_id, amount, currency, status, debtor_name, statement_ref, mandate_id, global_account_id, and created_at. Required: id (the direct debit's transaction_id).

list_all_airwallex_global_account_aliases

List aliases registered to a given Airwallex Global Account. Returns each alias with its id, status, type, value, local_clearing_system, and any pending next_action. Required: global_account_id.

airwallex_global_account_aliases_cancel

Cancel an Airwallex alias for a Global Account; once cancelled, the alias can no longer be used for any transactions, such as receiving funds. Returns the alias object with its id, status, type, value, local_clearing_system, and next_action. Required: aliase_id, global_account_id.

get_single_airwallex_global_account_alias_by_id

Get a single Airwallex alias by id. Returns the alias object including its id, status, type, value, local_clearing_system, next_action, and reason. Required: id, global_account_id.

create_a_airwallex_aliases_create

Create an alias for an Airwallex Global Account so it can receive funds, supporting the alias types EMAIL, PHONE_NUMBER, and AUSTRALIAN_BUSINESS_NUMBER. Returns: global_account_id, id, local_clearing_system, next_action, reason, request_id, status, type, value. For EMAIL or PHONE_NUMBER aliases a verification code is sent and must be submitted via the Submit Alias verification code endpoint to…

create_a_airwallex_aliase_initiate_port

Initiate an alias port for an Airwallex Global Account to transfer the alias to a different Global Account or an external bank account; the alias status then moves to PORT_INITIATED pending further action once it becomes portable. Returns the alias object including id, status, value, local_clearing_system, request_id, and next_action. Required: global_account_id, aliase_id, id.

list_all_airwallex_global_accounts

List all Airwallex global accounts created under your account. Returns: account_name, account_number, account_type, alternate_account_identifiers, close_reason, country_code, deposit_conversion_currency, failure_reason, iban, id, institution, nick_name, request_id, required_features, status, supported_features, swift_code.

get_single_airwallex_global_account_by_id

Get a single Airwallex global account by its unique id. Returns: account_name, account_number, account_type, alternate_account_identifiers, close_reason, country_code, deposit_conversion_currency, failure_reason, iban, id, institution, nick_name, request_id, required_features, status, supported_features, swift_code. Required: id.

airwallex_global_accounts_close

Close an Airwallex global account by id. Returns the closed account with id, status (CLOSED), close_reason, account_number, iban, and institution details. Required: global_account_id.

create_a_airwallex_global_account

Create a new Airwallex global account for receiving funds via the local clearing system or SWIFT. Returns: account_name, account_number, account_type, alternate_account_identifiers, country_code, deposit_conversion_currency, iban, id, institution, nick_name, request_id, required_features, status, supported_features, swift_code. Requires country_code, request_id, and required_features.

airwallex_global_accounts_generate_statement_letter

Generate an Airwallex global account statement letter for the account with the given id. Returns the statement letter as a binary PDF file stream. Requires global_account_id and account_statement_type.

update_a_airwallex_global_account_by_id

Update an existing global account in Airwallex, editing its nick_name, deposit_conversion_currency, or alternate_account_identifiers. Returns the updated global account object including id, status, account_number, nick_name, country_code, and iban. Required: global_account_id and nick_name.

list_all_airwallex_global_account_mandates

List Direct Debit Payout Mandates for an Airwallex global account, optionally filtered by status and a created_at time range. Returns mandates with id, currency, status, creditor_name, debtor_name, payment_scheme, setup_time, and created_at. Required: global_account_id.

airwallex_global_account_mandates_cancel

Cancel a Direct Debit Payout Mandate on an Airwallex global account by mandate id. Returns a boolean cancellation result flag. Required: global_account_id, mandate_id.

get_single_airwallex_global_account_mandate_by_id

Get a Direct Debit Payout Mandate from an Airwallex global account by mandate id. Returns: created_at, creditor_name, currency, debtor_name, global_account_id, id, payment_scheme, setup_time, status. Required: global_account_id, id.

list_all_airwallex_global_account_transactions

List transactions (funds received) for an Airwallex global account. Returns: has_more, items. Required: global_account_id, id.

create_a_airwallex_aliase_request_new_verification_code

Request a new verification code for a Global Account alias in Airwallex to continue the alias creation process. Returns the alias object including its id, status, local_clearing_system, next_action, and value. Required: global_account_id, aliase_id.

create_a_airwallex_aliase_submit_verification_code

Submit the email or SMS verification code for an Airwallex Global Account alias to complete alias creation. Returns the alias with its id, status, local_clearing_system, type, value, and next_action details. Required: global_account_id, aliase_id, and code. If the code has expired or the attempt limit is reached, request a new verification code first.

create_a_airwallex_linked_accounts_auth

Generate a Linked Account authentication in Airwallex to verify ownership of an external bank account through the Open Banking provider matching the chosen verification type (Plaid, Truelayer, EGIRO, or Basiq). Returns: egiro, plaid, truelayer, type. Required: type.

create_a_airwallex_linked_account_complete_auth

Complete the authentication refresh for an Airwallex linked account by submitting the verification provider's callback values (Plaid, TrueLayer, EGIRO, or Basiq). Returns a boolean result; once confirmed, the linked account status becomes SUCCEEDED. Required: linked_account_id, type.

create_a_airwallex_linked_account_confirm

Confirm an Airwallex Linked Account among its already-verified candidate accounts by submitting the chosen account_identity. Required: linked_account_id, account_identity. Returns an empty 204 response on success.

create_a_airwallex_linked_accounts_create

Create a Linked Account in airwallex to link an external bank account. Returns the created account with id, status, type, supported_currencies, verification next_action, and region-specific bank details. Required: request_id, type. If using Open Banking as the verification method, first generate an authentication token via the linked_accounts/auth endpoint.

list_all_airwallex_linked_accounts

List all Linked Accounts associated with a specific Airwallex account. Returns each account's id, type, status, supported_currencies, and country-specific bank details (e.g. au_bank, gb_bank, us_bank). Defaults to accounts created in the past 31 days when no created_at range is supplied.

get_single_airwallex_linked_account_by_id

Get a single Linked Account in Airwallex by its unique identifier. Returns the account's id, type, status, supported_currencies, verification next_action, and country-specific bank details. Required: id.

list_all_airwallex_linked_account_balances

List available balances for an Airwallex Linked Account. Returns: has_more, items. Required: linked_account_id and id (the Linked Account unique identifier). Only for Linked Accounts where capabilities.balance_check is true; requests route to the financial institutions, so responses may be slightly delayed.

create_a_airwallex_linked_account_auth

Refresh an expired Linked Account authentication in Airwallex to obtain a new Open Banking authorization token. Returns: egiro, plaid, truelayer, type. Required: linked_account_id and type (plus the provider object matching the chosen type). Call complete_auth after the provider callback or the linked account status stays REQUIRES_ACTION.

get_single_airwallex_linked_account_mandate_by_id

Get the Direct Debit Deposit Mandate for an Airwallex Linked Account by id. Returns: accepted_at, address, controls, email, reference, signatory, status, type, version. Required: id.

update_a_airwallex_linked_account_mandate_by_id

Add or renew a Direct Debit Deposit Mandate for an Airwallex Linked Account; the external bank account owner must sign the mandate to enable Direct Debits. Returns: accepted_at, address, controls, email, reference, signatory, status, type, version. Required: id, type. Email, signatory, and version are also required unless reusing an existing mandate (reuse_mandate_reference).

create_a_airwallex_linked_account_suspend

Suspend a linked account in Airwallex, which also revokes any mandate objects attached to it. Returns a boolean suspend result. Required: linked_account_id. Irreversible — to re-link you must create a new linked account and complete verification again.

create_a_airwallex_linked_account_verify_microdeposit

Verify a Linked Account in Airwallex by submitting the two micro-deposit amounts received in the account. Returns the linked account including id, status, capabilities, failure_details, and next_action. Required: linked_account_id, amounts (order agnostic).

list_all_airwallex_finance_financial_reports

List previously generated Airwallex financial reports, including balance activity, transaction reconciliation, settlement, account statement, and aggregated settlement reports. Returns report objects with id, type, status, file_format, file_name, report_version, and report_parameters.

get_single_airwallex_finance_financial_report_by_id

Get a single generated Airwallex financial report (balance activity, transaction reconciliation, settlement, or aggregated settlement) by id. Returns: file_format, file_name, id, report_expires_at, report_parameters, report_version, status, type. Required: id.

create_a_airwallex_finance_financial_report

Create an Airwallex financial report (balance activity, transaction reconciliation, settlement, account statement, or online payments transaction report). Returns the created report with id, type, status, file_format, file_name, report_expires_at, and report_parameters. Required: file_format, from_date, to_date, type.

get_single_airwallex_financial_report_content_by_id

Download the contents of a previously generated Airwallex financial report (balance activity, transaction reconciliation, settlement, or aggregated settlement). Returns the raw report file itself — not a JSON object — with the file format matching the report's file_format (PDF, Excel, CSV, or generic binary). Required: id (UUID of the financial report).

list_all_airwallex_financial_transactions

List Airwallex financial transactions that contributed to the account balance, from a specified creation date/time, with optional filters on end creation date/time, batch_id, and status. Returns transactions with id, amount, currency, status, fee, net, settled_at, and source_type.

get_single_airwallex_financial_transaction_by_id

Get a single Airwallex financial transaction by its unique identifier. Returns: amount, batch_id, client_rate, created_at, currency, currency_pair, description, estimated_settled_at, fee, funding_source_id, id, net, settled_at, source_id, source_type, status, transaction_type. Required: id.

list_all_airwallex_financial_settlements

List Airwallex financial settlements that contributed to the account balance from a specified settled date through an end settled date, for a given currency and status. Returns: has_more, items. Required: currency, from_settled_at, status, to_settled_at.

get_single_airwallex_financial_settlement_by_id

Get a single Airwallex settlement detail by specifying the settlement unique identifier. Returns: amount, created_at, currency, estimated_settled_at, fee, settlement_id, settled_at, status. Required: id.

get_single_airwallex_settlement_report_by_id

Get a single Airwallex batch settlement report by id. Returns: created_at, settlement_id, report_url, report_status. Required: id (the settlement batch unique identifier).

list_all_airwallex_issuing_authorizations

List all card authorizations for your Airwallex account. Returns has_more and items, where each item carries status, transaction_amount, billing_currency, merchant, and card_transaction_data. Defaults to the last 30 days unless an explicit date range is supplied; this legacy-model endpoint is deprecated.

get_single_airwallex_issuing_authorization_by_id

Get a single card authorization by id from Airwallex. Returns the authorization including status, auth_code, billing_amount, billing_currency, card_id, create_time, expiry_date, failure_reason, fee_details, merchant, and risk_details. Required: id. Deprecated: uses the legacy transaction model; prefer Transaction Events, Card Transactions, and Lifecycles.

list_all_airwallex_issuing_card_transaction_events

List all Airwallex Card Transaction Events, including each event's type, subtype, process result, and per-event amounts. Use lifecycle_id or card_transaction_id to trace the sequence of events within a lifecycle or card transaction. Returns: items, page_after, page_before. No required parameters; all filters are optional.

get_single_airwallex_issuing_card_transaction_event_by_id

Retrieve a single Airwallex card transaction event by id. Returns the full event object including id, type, subtype, process_result, billing_amount, transaction_amount, merchant details, fee_details, and failure_reason. Required: id.

list_all_airwallex_issuing_lifecycles

List Airwallex issuing card transaction lifecycles, each providing a network-level view of a payment with aggregated billing amounts. Returns: items, page_after, page_before. Use card_id to narrow results to a specific card. Max 100 per page.

get_single_airwallex_issuing_lifecycle_by_id

Get a single Airwallex card transaction lifecycle by id. Returns the lifecycle with aggregated billing amounts across all its card transactions and transaction events: id, card_id, billing_amounts, created_at, updated_at. Required: id.

list_all_airwallex_issuing_card_transactions

List Airwallex card transactions in paginated order. Returns: items, page_after, page_before. Max 100 per page.

get_single_airwallex_issuing_card_transaction_by_id

Get a single Airwallex card transaction by id. Returns: billing_amounts, card_id, created_at, digital_wallet_token, expiry_date, failure_reason, fee_details, fund_direction, id, lifecycle_id, masked_card_number, merchant, status, transaction_amounts, updated_at. Required: id.

list_all_airwallex_issuing_cardholders

List all Airwallex issuing cardholders created within your account. Returns each cardholder's cardholder_id, email, individual details, postal_address, status, and type.

get_single_airwallex_issuing_cardholder_by_id

Get the details of a single Airwallex issuing cardholder by id. Returns: cardholder_id, email, individual, mobile_number, postal_address, status, type. Required: id.

create_a_airwallex_issuing_cardholder

Create an Airwallex issuing cardholder (INDIVIDUAL or DELEGATE), which goes through Airwallex's name and sanction screening process. Returns the created cardholder: cardholder_id, email, individual, postal_address, status, and type. Required: email, individual, type.

delete_a_airwallex_issuing_cardholder_by_id

Delete an Airwallex issuing cardholder by its unique identifier. Deleting the cardholder also closes all employee cards linked to it. Returns: cardholder_id, deleted. Required: cardholder_id.

update_a_airwallex_issuing_cardholder_by_id

Update a cardholder in Airwallex Issuing with only the fields you provide; composite objects like name must be passed complete, and updating may re-trigger the name screening process. Returns the updated cardholder including cardholder_id, email, individual details, mobile_number, postal_address, status, and type. Required: cardholder_id.

airwallex_issuing_cards_activate

Activate a physical Airwallex card by id so it can be used for card payment authorizations. Returns an empty 202 Accepted response on success. Required: card_id.

list_all_airwallex_issuing_cards

List Airwallex cards issued under an account. Returns: additional_cardholder_ids, brand, card_id, card_number, card_status, cardholder_id, created_at, nick_name, updated_at. Defaults to a 30-day created_at window unless both from_created_at and to_created_at are supplied.

get_single_airwallex_issuing_card_by_id

Retrieve full details of a single Airwallex card by id. Returns the complete card object including card_id, card_number, card_status, brand, cardholder_id, authorization_controls, delivery_details, postal_address, and metadata. Required: id.

create_a_airwallex_issuing_card

Create a new card in Airwallex Issuing — physical or virtual — with spend controls, delivery details and program settings. Returns the created card including card_id, card_number, card_status, authorization_controls, form_factor, and created_at. Required: cardholder_id, created_by, form_factor, is_personalized, program, request_id, and authorization_controls.

update_a_airwallex_issuing_card_by_id

Update an existing Airwallex card by setting the values of the included parameters; parameters not included are left unchanged. Returns the updated card including card_id, card_number, card_status, authorization_controls, and updated_at. Required: card_id.

list_all_airwallex_card_details

Get sensitive card details for an Airwallex virtual card by id. Returns: card_number, cvv, expiry_month, expiry_year, name_on_card. Required: card_id. Only active cards return data.

list_all_airwallex_card_limits

8|List all Card Remaining Limits. Returns: cash_withdrawal_limits, currency, limits. Required: card_id.

create_a_airwallex_card_provision_digital_token

Provision an Airwallex issuing card into a digital wallet for in-app (push) provisioning. Returns: card_id, activation_data, encrypted_pass_data, ephemeral_public_key, expiration_date, enc_address, last4, opaque_payment_card, google_opaque_payment_card, card_type, vcard_id. Required: card_id and type — apple_pay also needs device_certs, nonce, and nonce_signature; google_pay or samsung_pay also…

list_all_airwallex_issuing_configs

Retrieve the default Airwallex issuing settings configured for your account. Returns: blocked_transaction_usages, enable_auto_conversion, primary_currency, remote_auth_settings, remote_call_config, remote_provisioning_config, spending_limit_settings, acquiring_institution_identifier, auth_code, billing_amount, billing_currency, card_id, client_data, create_time, digital_wallet_token_id,…

update_a_airwallex_config_update_by_id

Update the Airwallex issuing config — currently supports remote call config updates, plus auto currency conversion, remote authorization, and remote provisioning settings (those features require contacting Airwallex support to enable). Returns the updated setting: enable_auto_conversion, primary_currency, remote_auth_settings, remote_call_config, remote_provisioning_config, and…

list_all_airwallex_issuing_digital_wallet_tokens

List Airwallex digital wallet tokens created under an account, filterable by card, cardholder, creation window, expiry window, status, or type. Returns tokens with: card_id, token_id, token_status, token_type, masked_card_number, and create_time. Defaults to a 30-day created_at window unless both from_created_at and to_created_at are populated.

get_single_airwallex_issuing_digital_wallet_token_by_id

Get a single Airwallex digital wallet token by id. Returns the token's card_id, cardholder_id, token_status, token_type, device_information, expiry_month, expiry_year, masked_card_number, pan_reference_id, risk_information, token_reference_id, and create_time. Required: id (the digital wallet token's unique identifier).

airwallex_issuing_digital_wallet_tokens_lifecycle

Change an Airwallex digital wallet token's status — suspend, resume, delete, or activate via call centre verification. Applied asynchronously: the request is accepted immediately and the status change is confirmed with the card network. Returns an empty 202 response on success. Required: token_id, operation_type. CALL_CENTER_ACTIVATION also requires activation_code (up to 8 characters).

list_all_airwallex_issuing_merchant_brands

List merchant brands in Airwallex, returning all brands in alphabetical order or only those whose name matches the given prefix. Returns: id, logo_url, name.

get_single_airwallex_issuing_merchant_brand_by_id

Get a single merchant brand in Airwallex by its unique identifier. Returns: id, logo_url, name. Required: id.

airwallex_issuing_transaction_disputes_cancel

Cancel a transaction dispute in Airwallex while its status is still SUBMITTED; once the status is IN_PROGRESS the dispute is with the card scheme and can no longer be canceled, and dispute fees may apply. Returns the dispute object including id, status, detailed_status, reason, and updated_at. Required: dispute_id.

list_all_airwallex_issuing_transaction_disputes

List all transaction disputes in Airwallex, filterable by status, detailed_status, reason, reference, card_transaction_id, card_transaction_event_id, updated_by, and created/updated date ranges. Returns each dispute's id, amount, status, detailed_status, reason, created_at, and update_history.

get_single_airwallex_issuing_transaction_dispute_by_id

Retrieve a single transaction dispute in Airwallex by id. Returns the dispute object including id, amount, status, detailed_status, reason, created_at, updated_at, and update_history. Required: id.

create_a_airwallex_issuing_transaction_dispute

Create a transaction dispute in Airwallex for a disputed card transaction; the dispute starts in DRAFT status and can be updated multiple times before submission. Returns the created dispute including id, amount, status, reason, and created_at. Required: card_transaction_event_id.

airwallex_issuing_transaction_disputes_submit

Submit a transaction dispute to Airwallex for review and processing; after submission the dispute's status changes to SUBMITTED. Returns the dispute object including id, status, detailed_status, reason, and updated_at. Required: dispute_id.

update_a_airwallex_issuing_transaction_dispute_by_id

Update a transaction dispute in Airwallex. While the dispute is in DRAFT status all fields can be updated; once submitted, only new evidence or explanation can be added. Returns the updated dispute including id, amount, reason, status, detailed_status, notes, and created_at. Required: dispute_id, request_id.

list_all_airwallex_issuing_transactions

List all Airwallex issuing transactions for an account or a specific card. Returns items with transaction_id, status, transaction_type, transaction_amount, transaction_currency, card_id, merchant, fee_details, and risk_details. Defaults to a 30-day window unless both from_created_at and to_created_at are set. Legacy model — prefer the Transaction Events, Card Transactions, and Lifecycles…

get_single_airwallex_issuing_transaction_by_id

Get a single Airwallex issuing transaction by id. Returns: acquiring_institution_identifier, auth_code, billing_amount, billing_currency, card_id, card_nickname, client_data, digital_wallet_token_id, failure_reason, fee_details, card_transaction_data, masked_card_number, matched_authorizations, merchant, network_transaction_id, posted_date, retrieval_ref, risk_details, status, transaction_amount,…

create_a_airwallex_registered_domains_add_item

Register one or more web domains for Apple Pay in Airwallex. Returns: items. Required: items.

create_a_airwallex_registered_domains_remove_item

Remove one or more registered web domains from Apple Pay in Airwallex. Returns: items. Required: items (array of domains to remove).

list_all_airwallex_applepay_registered_domains

List all web domains registered in Apple Pay for the Airwallex account. Returns: items.com.

list_all_airwallex_config_banks

List the available banks in Airwallex for a payment method type so shoppers can choose one before confirming a Payment Intent. Returns: has_more, items.logo_url. Required: payment_method_type. Page size is capped at 1000.

list_all_airwallex_config_convertible_shopper_currencies

List all convertible shopper currencies in Airwallex that are enabled for creating a conversion quote and can be used as selectable options for payment currency conversion. Returns: items.g. AUD, USD, SGD, EUR, JPY).

list_all_airwallex_config_payment_method_types

List all available payment method types configured in Airwallex, including duplicates across one-off and recurring transaction modes. Returns: has_more, items. transaction_currency is required when country_code is supplied. Page size caps at 1000.

list_all_airwallex_config_reserve_plans

Get the current reserve plan configuration for your Airwallex account. Returns: delayed, delayed_rolling, rolling, type. No required parameters.

create_a_airwallex_conversion_quotes_create

Create a new conversion quote in Airwallex for converting from merchant currency to shopper currency. Returns: conversion_rate, created_at, expires_at, id, merchant_currency, shopper_currency, status, validity_period. Required: merchant_currency, request_id, shopper_currency.

get_single_airwallex_pa_conversion_quote_by_id

Get a single conversion quote in Airwallex by its unique id. Returns: conversion_rate, created_at, expires_at, id, merchant_currency, shopper_currency, status, validity_period. Required: id.

get_single_airwallex_pa_customer_balance_transaction_by_id

Get a Customer Balance Transaction in Airwallex by its unique id. Returns the transaction object including id, type, created_at, updated_at, and the bank_transfer detail object with amount, currency, received_at, status, payer, and bank_transfer_instructions. Required: id.

list_all_airwallex_pa_customers

List all Airwallex Payment Acceptance customers. Returns: address, business_name, client_secret, created_at, email, first_name, id, last_name, merchant_customer_id, metadata, phone_number, request_id, updated_at. Max 1000 per page.

get_single_airwallex_pa_customer_by_id

Get a single Airwallex Payment Acceptance customer by id. Returns: address, business_name, client_secret, created_at, email, first_name, id, last_name, merchant_customer_id, metadata, phone_number, request_id, updated_at. Required: id.

create_a_airwallex_pa_customer

Create an Airwallex Payment Acceptance customer. Returns the customer including id, request_id, merchant_customer_id, first_name, last_name, email, phone_number, client_secret, created_at, and updated_at. Required: merchant_customer_id, request_id.

airwallex_pa_customers_generate_client_secret

Generate a client secret for an Airwallex Payment Acceptance customer so it can be used as the HTTP header `client-secret` from client-side to create or list Payment Methods. Returns: client_secret, expired_time. Required: customer_id.

update_a_airwallex_pa_customer_by_id

Update an Airwallex Payment Acceptance customer's personal information. Returns the updated customer including id, request_id, merchant_customer_id, first_name, last_name, email, phone_number, client_secret, created_at, and updated_at. Required: customer_id, request_id.

get_single_airwallex_pa_customs_declaration_by_id

Get an Airwallex customs declaration by its unique identifier. Returns: awx_request_id, created_at, customs_details, customs_status_message, id, payment_method_type, provider_transaction_id, request_id, shopper_identity_check_result, status, sub_order, updated_at, verification_department_code, verification_department_transaction_id. Required: id (the customs declaration id, e.g.…

create_a_airwallex_pa_customs_declaration

Create an Airwallex customs declaration for a payment intent to start the declaration process. Returns: awx_request_id, created_at, customs_details, customs_status_message, id, payment_method_type, provider_transaction_id, request_id, shopper_identity_check_result, status, sub_order, updated_at, verification_department_code, verification_department_transaction_id. Requires request_id,…

airwallex_pa_customs_declarations_redeclare

Redeclare an existing Airwallex customs declaration. Returns the updated declaration including id, status (e.g. REDECLARED), request_id, customs_details, sub_order, and created_at/updated_at. Required: customs_declaration_id and request_id (max length 64). SHANGHAI_CBT does not support redeclaration after a successful declaration.

update_a_airwallex_pa_customs_declaration_by_id

Update an existing Airwallex customs declaration. Returns the updated declaration including id, status, request_id, customs_details, sub_order, and created_at/updated_at. Required: customs_declaration_id and request_id (max length 64). SHANGHAI_CBT does not support update after a successful declaration.

list_all_airwallex_pa_funds_split_reversals

List Airwallex Funds Split Reversals for a given Funds Split. Returns: amount, created_at, funds_split_id, id, metadata, request_id, status. Required: funds_split_id.

get_single_airwallex_pa_funds_split_reversal_by_id

Get a single Airwallex Funds Split Reversal by id. Returns the reversal object including id, request_id, funds_split_id, amount, status, metadata, and created_at. Required: id.

create_a_airwallex_pa_funds_split_reversal

Create an Airwallex Funds Split Reversal to take money back from a connected account; partial reversals are allowed until the Funds Split is fully reversed. Returns: amount, created_at, funds_split_id, id, metadata, request_id, status. Required: amount, funds_split_id, request_id. Errors if the Funds Split is already fully reversed or the amount exceeds the remaining unreversed amount.

list_all_airwallex_pa_funds_splits

List all Funds Splits in airwallex for a given source. Returns: amount, auto_release, created_at, currency, destination, id, metadata, request_id, source_id, source_type, status. Required: source_id, source_type (currently only PAYMENT_INTENT is supported).

get_single_airwallex_pa_funds_split_by_id

Retrieve a Funds Split in airwallex by its unique id. Returns: amount, auto_release, created_at, currency, destination, id, metadata, request_id, source_id, source_type, status. Required: id.

create_a_airwallex_pa_funds_split

Create a Funds Split in airwallex to divide collected funds from a succeeded Payment Intent to a destination account. Returns: amount, auto_release, created_at, currency, destination, id, metadata, request_id, source_id, source_type, status. Requires request_id, source_id, source_type, amount, and destination. A split can be created only after the Payment Intent succeeds and before funds…

airwallex_pa_funds_splits_release

Release a Funds Split in airwallex so the funds arrive at the destination. Returns: amount, auto_release, created_at, currency, destination, id, metadata, request_id, source_id, source_type, status. Required: funds_split_id and request_id. Only available for splits with auto_release=false.

list_all_airwallex_pa_payment_attempts

List all Airwallex Payment Attempts, optionally filtered by payment_intent_id, currency, status, and a created_at date range. Returns has_more and items, where each item includes id, amount, currency, status, payment_method details, captured_amount, and refunded_amount.

get_single_airwallex_pa_payment_attempt_by_id

Get a single Airwallex Payment Attempt by id. Returns: acquirer_reference_number, amount, authentication_data, authorization_code, captured_amount, created_at, currency, dcc_data, failure_code, failure_details, id, merchant_advice_code, merchant_order_id, payment_consent_id, payment_intent_id, payment_method, payment_method_options, payment_method_transaction_id, provider_original_response_code,…

airwallex_pa_payment_consents_disable

Disable an Airwallex Payment Consent by id; its status becomes DISABLED and it can no longer be used or updated. Returns: client_secret, connected_account_id, created_at, customer_id, disable_reason, failure_reason, id, initial_payment_intent_id, mandate, merchant_trigger_reason, metadata, next_action, next_triggered_by, payment_method, request_id, status, terms_of_use, updated_at,…

list_all_airwallex_pa_payment_consents

List Airwallex Payment Consents, filterable by customer, Payment Method, status, trigger reason, and creation-time range. Returns: client_secret, connected_account_id, created_at, customer_id, disable_reason, failure_reason, id, initial_payment_intent_id, mandate, merchant_trigger_reason, metadata, next_action, next_triggered_by, payment_method, request_id, status, terms_of_use, updated_at,…

get_single_airwallex_pa_payment_consent_by_id

Get a single Airwallex Payment Consent by id. Returns: client_secret, connected_account_id, created_at, customer_id, disable_reason, failure_reason, id, initial_payment_intent_id, mandate, merchant_trigger_reason, metadata, next_action, next_triggered_by, payment_method, request_id, status, terms_of_use, updated_at, payment_method_type, payment_method_id. Required: id.

airwallex_pa_payment_consents_verify

Verify an Airwallex Payment Consent with payment_method details (or an existing Payment Method id) to store credentials for subsequent payments; next_action is returned when customer action is needed. Returns: client_secret, connected_account_id, created_at, customer_id, disable_reason, failure_reason, id, initial_payment_intent_id, mandate, merchant_trigger_reason, metadata, next_action,…

create_a_airwallex_pa_payment_consent

Create an Airwallex Payment Consent for a customer who will make payments. Returns: client_secret, connected_account_id, created_at, customer_id, disable_reason, failure_reason, id, initial_payment_intent_id, mandate, merchant_trigger_reason, metadata, next_action, next_triggered_by, payment_method, request_id, status, terms_of_use, updated_at, payment_method_type, payment_method_id. Required:…

airwallex_pa_payment_consents_verify_continue

Continue to verify an Airwallex payment consent when the verification method is micro-deposit, or retry a failed micro-debit. Returns the updated payment consent with id, request_id, customer_id, status, next_triggered_by, merchant_trigger_reason, client_secret, mandate, and created_at/updated_at timestamps. Required: payment_consent_id, request_id.

list_all_airwallex_pa_payment_disputes

List all Airwallex Payment Disputes, filterable by stage, status, reason code, due date, created time, or updated time. Returns: accept_details, acquirer_reference_number, ai_dispute_automation, amount, card_brand, challenge_details, connected_account_id, created_at, currency, customer_id, customer_name, due_at, id, issuer_comment, issuer_documents, merchant_order_id, metadata, mode,…

get_single_airwallex_pa_payment_dispute_by_id

Get a single Airwallex Payment Dispute by its unique identifier. Returns: accept_details, acquirer_reference_number, ai_dispute_automation, amount, card_brand, challenge_details, connected_account_id, created_at, currency, customer_id, customer_name, due_at, id, issuer_comment, issuer_documents, merchant_order_id, metadata, mode, payment_attempt_id, payment_intent_id, payment_method_type, reason,…

airwallex_pa_payment_disputes_accept

Accept a Payment Dispute in airwallex while it is under REQUIRES_RESPONSE status to avoid further escalation and fees. Returns the dispute object including id, stage, status, amount, currency, and accept_details. Required: dispute_id, request_id. Accepting at the RFI stage triggers a refund, customizable via refund.

airwallex_pa_payment_disputes_challenge

Challenge an Airwallex payment dispute that is in REQUIRES_RESPONSE status at CHARGEBACK or RFI stage. Returns: accept_details, acquirer_reference_number, ai_dispute_automation, amount, card_brand, challenge_details, connected_account_id, created_at, currency, customer_id, customer_name, due_at, id, issuer_comment, issuer_documents, merchant_order_id, metadata, mode, payment_attempt_id,…

update_a_airwallex_pa_payment_dispute_by_id

Update an Airwallex payment dispute by dispute_id. Currently only the metadata field can be updated. Returns: accept_details, acquirer_reference_number, ai_dispute_automation, amount, card_brand, challenge_details, connected_account_id, created_at, currency, customer_id, customer_name, due_at, id, issuer_comment, issuer_documents, merchant_order_id, metadata, mode, payment_attempt_id,…

list_all_airwallex_payment_dispute_related_payment_intents

List the payment intents related to an Airwallex payment dispute. Returns: items, page_after, page_before. Only applicable when the dispute reason type is FRAUDULENT or DUPLICATE_CHARGE. Required: payment_dispute_id. Max 100 per page.

airwallex_pa_payment_intents_cancel

Cancel an Airwallex Payment Intent; only intents in REQUIRES_PAYMENT_METHOD, REQUIRES_CUSTOMER_ACTION, or REQUIRES_CAPTURE status can be cancelled, and any outstanding un-captured funds are refunded. Returns the cancelled intent with id, status, amount, currency, and updated_at. Required: payment_intent_id, request_id.

list_all_airwallex_pa_payment_intents

List all Airwallex Payment Intents, filterable by currency, status, created-at window, merchant_order_id, and payment_consent_id. Returns each intent with id, amount, currency, status, latest_payment_attempt, and created_at. Max 1000 per page.

get_single_airwallex_pa_payment_intent_by_id

Get a single Airwallex Payment Intent by id. Returns the full intent including id, amount, currency, status, and latest_payment_attempt with payment method and authentication details. Required: id.

airwallex_pa_payment_intents_capture

Capture funds for a confirmed Airwallex Payment Intent; only intents with auto_capture=false whose next_action indicates capture is required can be captured. Returns the updated intent with id, status, amount, currency, and latest_payment_attempt. Required: payment_intent_id, request_id.

airwallex_pa_payment_intents_confirm

Confirm an Airwallex Payment Intent when the customer is ready to pay, supplying the payment_method funding source. Returns the intent with id, status, next_action (redirect or QR code), return_url, and latest_payment_attempt. Required: payment_intent_id, request_id, payment_method.

airwallex_pa_payment_intents_confirm_continue

Continue confirming an Airwallex Payment Intent when additional customer information is required after the initial confirmation (e.g. 3DS, DCC, or micro-deposit verification). Returns the updated intent: id, status, amount, currency, latest_payment_attempt, updated_at. Requires payment_intent_id and request_id.

create_a_airwallex_pa_payment_intent

Create a Payment Intent in Airwallex to start collecting payment from your customer. Returns the created intent: id, amount, currency, status, client_secret, metadata, created_at. Requires amount, currency, merchant_order_id, and request_id.

airwallex_pa_payment_intents_increment_authorization

Authorize additional funds on an existing Airwallex Payment Intent before capture, useful when the final amount is unknown upfront (e.g. hotel or car rental); only a single capture and clearing occurs for the final authorized amount. Returns the updated intent: id, status, amount, currency, updated_at. Requires payment_intent_id, amount, and request_id.

update_a_airwallex_pa_payment_intent_by_id

Update properties on an Airwallex Payment Intent; omitted fields are ignored, provided fields are merged (arrays are fully replaced), and some properties can only be updated in REQUIRES_PAYMENT_METHOD or REQUIRES_CUSTOMER_ACTION status. Returns the updated intent: id, status, amount, currency, order, metadata, updated_at. Requires payment_intent_id and request_id.

airwallex_pa_payment_links_activate

Activate a Payment Link in Airwallex, making an inactive link usable again for payments. Returns the updated payment link object including id, active, status, amount, currency, and url. Required: payment_link_id.

airwallex_pa_payment_links_deactivate

Deactivate a Payment Link in Airwallex, retiring an active link so it can no longer be paid. Returns the updated payment link object including id, active, status, amount, currency, and url. Required: payment_link_id.

list_all_airwallex_pa_payment_links

List all Airwallex payment links the merchant has created previously. Returns each link's id, title, status, amount, currency, reusable, created_at, and url. Max 1000 per page.

get_single_airwallex_pa_payment_link_by_id

Get a single Airwallex payment link by id. Returns the full payment link object including id, title, status, amount, currency, reusable, url, and created_at. Required: id.

create_a_airwallex_pa_payment_link

Create an Airwallex payment link that shoppers pay through at the returned checkout url. Returns: active, amount, collectable_shopper_info, created_at, currency, customer_id, default_currency, description, expires_at, id, latest_successful_payment_intent_id, metadata, reference, reusable, status, successful_payment_intent_count, supported_currencies, title, updated_at, url. Required: reusable,…

airwallex_pa_payment_links_notify_shopper

Send an email notification to a shopper in Airwallex containing their payment link. Returns a confirmation string on success. Required: payment_link_id and shopper_email.

update_a_airwallex_pa_payment_link_by_id

Update attributes of an existing Airwallex payment link. Returns the updated payment link including id, amount, currency, status, url, and reusable. Required: payment_link_id.

airwallex_pa_payment_methods_disable

Disable an Airwallex payment method by its unique identifier, setting its status to DISABLED. Returns: ach_direct_debit, applepay, bacs_direct_debit, becs_direct_debit, card, created_at, customer_id, eft_direct_debit, googlepay, id, metadata, request_id, sepa_direct_debit, status, type, updated_at. Required: payment_method_id, id, request_id.

list_all_airwallex_pa_payment_methods

List all Airwallex payment methods. Returns: ach_direct_debit, applepay, bacs_direct_debit, becs_direct_debit, card, created_at, customer_id, eft_direct_debit, googlepay, id, metadata, request_id, sepa_direct_debit, status, type, updated_at.

get_single_airwallex_pa_payment_method_by_id

Get a single Airwallex payment method by id. Returns: ach_direct_debit, applepay, bacs_direct_debit, becs_direct_debit, card, created_at, customer_id, eft_direct_debit, googlepay, id, metadata, request_id, sepa_direct_debit, status, type, updated_at. Required: id.

create_a_airwallex_pa_payment_method

Create an Airwallex payment method (card, applepay, or googlepay) that can be referenced by a Payment Consent. Returns: ach_direct_debit, applepay, bacs_direct_debit, becs_direct_debit, card, created_at, customer_id, eft_direct_debit, googlepay, id, metadata, request_id, sepa_direct_debit, status, type, updated_at. Required: customer_id, request_id, type.

update_a_airwallex_pa_payment_method_by_id

Update an Airwallex payment method's details, such as card expiry and billing information, depending on the payment method type. Returns: ach_direct_debit, applepay, bacs_direct_debit, becs_direct_debit, card, created_at, customer_id, eft_direct_debit, googlepay, id, metadata, request_id, sepa_direct_debit, status, type, updated_at. Required: payment_method_id, card, request_id.

list_all_airwallex_bin_lookups

Look up the Airwallex BIN info for a card by passing its PAN. Returns a list of matching issuer records including card_brand, card_type, commercial_card, issuer_country_code, issuer_name, and product_description.

list_all_airwallex_pa_refunds

List all Refunds in Airwallex. Returns each refund with id, request_id, payment_intent_id, payment_attempt_id, amount, currency, reason, status, created_at, and updated_at. Filter by payment_intent_id, payment_attempt_id, currency, status, connected_account_id, or a created_at time range. Max 1000 per page.

get_single_airwallex_pa_refund_by_id

Retrieve a single Refund in Airwallex by its unique identifier. Returns: acquirer_reference_number, amount, connected_account_id, created_at, currency, failure_details, id, metadata, payment_attempt_id, payment_intent_id, reason, request_id, status, updated_at. Required: id.

create_a_airwallex_pa_refund

Create a refund in Airwallex against a payment intent or payment attempt. Returns the created refund object including id, amount, currency, status, reason, payment_intent_id, created_at, and updated_at. Required: request_id and either payment_intent_id or payment_attempt_id. If amount is omitted, the full remaining captured amount is refunded.

list_all_airwallex_pa_settlement_records

List Airwallex settlement records for Payment Acceptance transactions. Returns: has_more, items, page_after. Max 50 per page.

airwallex_pos_terminals_activate

Activate an Airwallex POS Terminal by id. Returns the Terminal object including id, status, admin_password_status, refund_password_status, model, and nickname. Required: terminal_id, request_id.

airwallex_pos_terminals_deactivate

Deactivate an Airwallex POS Terminal by id. Returns the Terminal object including id, status (set to INACTIVE), admin_password_status, refund_password_status, model, and serial_number. Required: terminal_id, request_id.

list_all_airwallex_pos_terminals

List Airwallex POS Terminals, filterable by connected_account_id, device_model, nickname, serial_number, and status. Returns each Terminal's id, status, model, nickname, serial_number, and admin_password_status. Max 1000 per page.

get_single_airwallex_pos_terminal_by_id

Get an Airwallex POS Terminal by id. Returns the full Terminal object including id, status, model, nickname, serial_number, and connected_account_id. Required: id.

create_a_airwallex_terminal_cancel_current_operation

Cancel the current operation on an Airwallex POS terminal if possible. Returns the terminal object including id, nickname, model, serial_number, status, and connected_account_id. Required: terminal_id and id (terminal unique identifier).

create_a_airwallex_terminals_create

Create a new Terminal in airwallex. Returns the created terminal object including id, nickname, model, serial_number, status, admin_password_status, and refund_password_status. Required: activation_code, request_id (max length 64).

create_a_airwallex_terminal_process_payment_intent

Process a Payment Intent in an Airwallex POS terminal. Returns the Terminal object including its id, status, nickname, model, serial_number, and connected_account_id. Required: terminal_id, payment_intent_id, request_id.

create_a_airwallex_terminal_reset_password

Reset a Terminal password in Airwallex. Returns the updated Terminal object including its id, status, admin_password_status, and refund_password_status. Required: terminal_id (the Terminal's unique identifier, also supplied as id) and request_id (max 64 chars).

create_a_airwallex_terminal_terminate

Terminate an Airwallex POS terminal. Returns the terminal object reflecting the terminated state, including its id, status, model, nickname, serial_number, and connected_account_id. Required: terminal_id, request_id.

update_a_airwallex_terminal_update_by_id

Update a POS terminal in Airwallex by id, typically changing its nickname. Returns the updated terminal object including id, nickname, status, model, serial_number, connected_account_id, admin_password_status, and refund_password_status. Required: id, request_id.

create_a_airwallex_batch_transfer_add_item

Add items to an Airwallex batch transfer. Returns the updated batch transfer including id, name, status, total_item_count, valid_item_count, funding, and quote_summary. Only allowed while the batch is DRAFTING; max 100 items per call, 1000 per batch. Required: batch_transfer_id and items (each needs reason, reference, request_id, source_currency, transfer_currency, transfer_method).

delete_a_airwallex_batch_transfer_delete_by_id

Delete a batch transfer in Airwallex before it is submitted; only batches whose status is DRAFTING can be deleted. Returns the batch transfer object including id, name, status, funding details, quote_summary, and total/valid item counts. Required: batch_transfer_id and id.

list_all_airwallex_batch_transfers

List all Airwallex batch transfers with optional filters by request_id, short_reference_id, or status. Returns: funding, id, metadata, name, quote_summary, remarks, request_id, short_reference_id, status, total_item_count, transfer_date, updated_at, valid_item_count.

get_single_airwallex_batch_transfer_by_id

Get a single Airwallex batch transfer by id. Returns the full batch transfer record including funding details, quote summary, item counts, and metadata. Required: id.

create_a_airwallex_batch_transfer

Create a new batch transfer in Airwallex. Returns the created batch transfer including id, status, request_id, quote summary, and item counts. Required: request_id.

list_all_airwallex_batch_transfer_items

List all items added to a batch transfer in Airwallex. Returns: errors, id, request_id, status, transfer_draft, transfer_id, updated_at. Required: batch_transfer_id. Max 1000 per page.

create_a_airwallex_batch_transfer_quote

Quote a batch transfer in Airwallex to lock FX rates for its valid items; only possible while the batch status is DRAFTING or IN_APPROVAL. Returns the batch transfer including id, name, status, quote_summary, and funding. Required: batch_transfer_id.

create_a_airwallex_batch_transfer_submit

Submit a batch transfer for processing in Airwallex by specifying its id. Only valid items in the batch are submitted; the batch transitions to SCHEDULED status when no approval is required, or IN_APPROVAL when approval is required. Returns the batch transfer including id, status, name, funding, quote_summary, total_item_count, and valid_item_count. Required: batch_transfer_id.

create_a_airwallex_beneficiary_api_schemas_generate

Generate the Airwallex beneficiary API schema for a payment scenario. Returns: condition, fields, key. The body is a condition map depending on type (BANK_ACCOUNT, DIGITAL_WALLET, CARD): bank accounts take entity_type, bank_country_code, account_currency, transfer_method, local_clearing_system; digital wallets take entity_type, provider; cards take only type.

create_a_airwallex_beneficiary_form_schemas_generate

Retrieve the Airwallex beneficiary form schema used to build a custom UI for collecting beneficiary bank account and contact details, with field validation rules maintained by Airwallex so schema updates require no code changes. Returns: condition, fields, key. Required: type (BANK_ACCOUNT, DIGITAL_WALLET, or CARD); the other request parameters depend on the beneficiary type.

list_all_airwallex_beneficiaries

List all beneficiaries stored in Airwallex with optional filters on created dates, name, nickname, company name, bank account number, entity type, and transfer type. Returns: beneficiary, id, nickname, payer_entity_type, sca_exemptible, transfer_methods.

get_single_airwallex_beneficiary_by_id

Retrieve a specific Airwallex beneficiary by id. Returns: beneficiary, id, nickname, payer_entity_type, sca_exemptible, transfer_methods, examples. Required: id.

create_a_airwallex_beneficiary

Create a new beneficiary to be stored on the Airwallex platform. Returns: beneficiary, id, nickname, payer_entity_type, sca_exemptible, transfer_methods. Requires beneficiary and transfer_methods.

delete_a_airwallex_beneficiary_by_id

Delete an existing beneficiary stored on the Airwallex platform by beneficiary_id. Returns true if the beneficiary was successfully deleted, or false if the deletion did not take place. Required: beneficiary_id.

update_a_airwallex_beneficiary_by_id

Edit an existing beneficiary stored on the Airwallex platform, identified by beneficiary_id. Returns: beneficiary, id, nickname, payer_entity_type, sca_exemptible, transfer_methods. Requires beneficiary_id, beneficiary, and transfer_methods.

list_beneficiary_form_schemas_supported_financial_institutions

List all financial institutions supported by Airwallex for beneficiaries, to build your own payout interface. Returns: label, value. Required: account_currency, bank_country_code, entity_type, transfer_method.

create_a_airwallex_beneficiaries_validate

Validate an Airwallex beneficiary payload before creating it. Returns a 200 OK when the payload passes; failed fields come back with code, details (per-field errors with code and source), and message. Required: beneficiary, transfer_methods.

create_a_airwallex_beneficiaries_verify_account

Verify a beneficiary account in Airwallex before creating a transfer, checking that the account exists and returning a name-matching result where supported. Returns: code, details, message. Required: entity_type, transfer_method.

list_all_airwallex_payers

List all payers in Airwallex with optional filters on created_at date range, name, nickname, and entity type. Returns the payer contact: id, nickname, and payer details (entity_type, company_name, address, additional_info).

get_single_airwallex_payer_by_id

Get a single Airwallex payer contact by id (the Airwallex payer_id). Returns: id, nickname, payer. Required: id.

create_a_airwallex_payer

Create a new payer in Airwallex. Returns the created payer contact including id, nickname, and payer details (entity_type, company_name, address, additional_info). Requires payer (with address.country_code and entity_type); other fields are optional.

delete_a_airwallex_payer_by_id

Delete an existing payer in Airwallex by id. Returns a boolean flag indicating whether the deletion succeeded. Required: payer_id.

update_a_airwallex_payer_by_id

Update an existing payer in Airwallex by id. Returns the updated payer contact including id, nickname, and payer details (entity_type, company_name, address, additional_info). Requires payer_id and payer (with address.country_code and entity_type).

create_a_airwallex_payers_schema

Retrieve the dynamic payer field schema in Airwallex by submitting a partial payer request, for generating a dynamic payer form user interface. Returns: errors, schema. Required: payer with entity_type and address.country_code. Beta endpoint.

create_a_airwallex_payers_validate

Validate a payer's details in Airwallex before creating it. Returns a 200 OK response with no body fields when the payer passes validation; validation failures are returned as a 400 error listing the failed fields. Required: payer (with address.country_code and entity_type); any subset of additional payer fields can be supplied.

airwallex_transfers_cancel

Cancel an Airwallex transfer by id. Returns the updated transfer object including its id, status, source_amount, transfer_amount, and updated_at. Required: transfer_id.

list_all_airwallex_transfers

List Airwallex transfers. Returns: amount_beneficiary_receives, amount_payer_pays, application_fee_options, application_fees, batch_transfer_id, beneficiary, beneficiary_id, conversion, created_at, dispatch_date, dispatch_info, failure, fee_amount, fee_currency, fee_paid_by, funding, id, lock_rate_on_create, metadata, payer, payer_id, prepayment, reason, reference, remarks, request_id,…

get_single_airwallex_transfer_by_id

Get a single Airwallex transfer by id. Returns the full transfer object including id, status, transfer_amount, transfer_currency, source_amount, beneficiary, and created_at. Required: id.

create_a_airwallex_transfers_create

Create a new transfer to a beneficiary in Airwallex, with an optional underlying currency conversion when the transfer and source currencies differ. Returns the created transfer including id, status, amount_beneficiary_receives, amount_payer_pays, fee_amount, and fee_currency. Required: reason, reference, request_id, transfer_currency. Additional required fields vary by destination and payout…

airwallex_transfers_creates_validate

Validate a transfer request in Airwallex before creating it. Returns an empty 200 body when the request is valid; validation failures are returned as a 400 error. Required: reason, reference, request_id, transfer_currency.

airwallex_transfers_creates_confirm_funding

Confirm funding of an Airwallex transfer under the post-funding settlement model, moving its funding status from REQUIRES_FUNDING_CONFIRMATION to SCHEDULED. Returns the updated transfer including id, status, funding, amount_beneficiary_receives, and created_at. Required: transfer_id.

create_a_airwallex_issuing_fraud_feedback

Create a fraud feedback record in Airwallex confirming whether an issuing transaction was authorized by the cardholder. Returns: authorization_id, card_id, cardholder_decision. Required: authorization_id.

list_all_airwallex_rfis

List all RFIs raised for your Airwallex account, sorted by RFI creation date in descending order. Returns each RFI's id, account_id, status, type, created_at, active_request, and answered_requests. Filter by from_created_at, end_created_at, statuses, and types.

get_single_airwallex_rfi_by_id

Retrieve the details of a single RFI by its unique identifier. Returns the full RFI object including id, account_id, status, type, sub_type, created_at, active_request, and answered_requests. Required: id.

create_a_airwallex_rfi_respond

Respond to a Request for Information (RFI) in Airwallex by submitting answers to its questions. Returns the RFI session with id, status, active_request, and answered_requests. Required: rfi_id, questions.

create_a_airwallex_sellers_create

Create a new seller for your Merchant of Record account in Airwallex by submitting the seller's business details (trading name, address, registration info, and websites). Returns the created seller's status record: id, status, created_at, and updated_at.

airwallex_sellers_deactivate

Deactivate an existing Airwallex seller by its unique identifier. Returns the seller's status record including id, status, created_at, and updated_at. Required: seller_id.

get_single_airwallex_seller_by_id

Get the details of a single Airwallex seller by id. Returns the full seller record including id, status, created_at, and updated_at plus business details such as legal_entity_name, address, email, and websites. Required: id.

create_a_airwallex_watchlist_create

Add an item to the Airwallex Watchlist so the risk engine evaluates it on future transactions. Returns the created list item including id, action, type, value, status, request_id, and created_at. Required: action, request_id, type, value. The ACCEPT action is limited to users with good fraud performance and subject to reasonable usage limits.

list_all_airwallex_risk_watchlists

List Airwallex risk Watchlist items, sorted by creation date in descending order. Returns each item's action, status, type, value, reason, and created_at/updated_at timestamps. Up to 2000 items per page.

get_single_airwallex_risk_watchlist_by_id

Get a single Airwallex risk Watchlist item by id (the Airwallex item_id). Returns the item including id, action, status, type, value, reason, request_id, and created_at/updated_at timestamps. Required: id.

update_a_airwallex_update_by_id

Update an existing Watchlist item in Airwallex. Returns the updated list item including action, type, value, status, reason, request_id, id, and created_at/updated_at timestamps. Required: item_id, request_id.

create_a_airwallex_terms_and_conditions_agree

Record an Airwallex account's agreement to the terms and conditions. Returns the full account object including id, status, customer_agreements (with the recorded terms_and_conditions agreement), account_details, and requirements. Required: account_id.

create_a_airwallex_accounts_create

Create a new Airwallex account for your users, merchants, subsidiaries, business partners or clients. Returns the created Account object including account_details (business details, addresses, identifiers, attachments) and business_person_details. No request fields are required at creation; additional information can be appended later via the update account, file service, and…

create_a_airwallex_amendments_create

Create an amendment to edit account data for a KYC-verified Airwallex account. Returns: id, primary_contact, status, store_details, target. Payload must match target (primary_contact or account_details.store_details); store_details submissions must supply the store fields documented in the schema.

list_all_airwallex_accounts

Retrieve account details for your own Airwallex account. Returns: account_details, created_at, customer_agreements, id, identifier, metadata, next_action, nickname, primary_contact, reactivate_details, requirements, status, suspend_details, view_type, has_more. Takes no parameters.

create_a_airwallex_account_reactivate

Reactivate a suspended Airwallex account, changing its status from SUSPENDED to ACTIVE; the change also applies to all accounts under the same client legal entity. Returns the affected account objects (one per impacted account) with id, status, reactivate_details, and account_details. Required: account_id.

get_single_airwallex_account_amendment_by_id

Get an Airwallex account amendment by id. Returns: id, primary_contact, status, store_details, target. Required: id.

airwallex_account_amendments_approve

Approve a PENDING account amendment in Airwallex (sandbox-only simulation). The action is asynchronous and does not guarantee an immediate status change. Returns: id, primary_contact, status, store_details, target. Required: amendment_id.

airwallex_account_amendments_reject

Reject a PENDING account amendment in Airwallex (sandbox-only simulation). The action is asynchronous and does not guarantee an immediate status change. Returns: id, primary_contact, status, store_details, target. Required: amendment_id.

list_all_airwallex_account_wallet_infos

Get the Airwallex wallet information for your own account — the account name and account number other businesses on Airwallex can find you with. Returns: account_name, account_number. Takes no parameters.

create_a_airwallex_account_submit

Submit an Airwallex account for activation once all mandatory fields and documentation have been uploaded via the create/update account endpoints. Returns the submitted account object including id, status, account_details, requirements, primary_contact, and created_at. Required: account_id. Re-submit after updating primary_contact email or mobile for individual accounts.

create_a_airwallex_account_suspend

Suspend an Airwallex account, changing its status from ACTIVE to SUSPENDED; the change is temporary and reversible with Reactivate. Returns an array of impacted Account objects including id, status, account_details, suspend_details, and customer_agreements; the suspension also applies to all accounts under the same client legal entity. Required: account_id, id.

update_a_airwallex_account_update_by_id

Update a connected Airwallex account's information prior to submitting it for activation. Returns the updated Account object including its id, account_details (business and business-person details), nickname, metadata, created_at, and updated_at. Required: id (Airwallex account unique identifier).

create_a_airwallex_charges_create

Create a charge to be applied to a connected Airwallex account. Returns the charge object including its id, amount, currency, status, fee, and short_reference_id. Required: amount, currency, reason, reference, request_id, source.

list_all_airwallex_charges

List all charges created by your Airwallex account, sorted by creation time. Returns each charge with: id, amount, currency, fee, status, created_at, and updated_at.

get_single_airwallex_charge_by_id

Get the details of a previously created Airwallex charge by id. Returns: amount, created_at, currency, fee, id, reason, reference, request_id, short_reference_id, source, status, updated_at. Required: id.

create_a_airwallex_connected_account_transfers_create

Create a connected account transfer in Airwallex to send funds from your account to a connected account. Returns the created transfer including id, status, amount, currency, fee, short_reference_id, and created_at. Requires amount, currency, destination, reason, reference, and request_id. Your Airwallex balance must cover the transfer amount or the call fails with an Insufficient Funds error.

list_all_airwallex_connected_account_transfers

List all connected account transfers created by your Airwallex account, sorted by creation time. Returns transfers with id, amount, currency, status, fee, reference, and created_at.

get_single_airwallex_connected_account_transfer_by_id

Get transaction details for a connected account transfer in Airwallex by id. Returns the transfer with id, amount, currency, status, fee, reference, failure_reasons, and additional_info. Required: id.

create_a_airwallex_hosted_flow_authorize

Authorize a hosted flow instance in Airwallex, explicitly granting the user access so you can redirect them to the returned url. Returns: authorization_code, id, metadata, result, status, url. Required: hosted_flow_id.

create_a_airwallex_hosted_flows_create

Create an Airwallex hosted flow instance for a connected account, following a hosted flow template provided by Airwallex. Returns the created flow object including its id, status, url, metadata, and result. Required: account_id, template.

get_single_airwallex_hosted_flow_by_id

Get a single Airwallex hosted flow instance by its unique id. Returns the hosted flow object including its id, status, url, metadata, and result. Required: id.

create_a_airwallex_invitation_links_create

Create an Airwallex account invitation link to onboard a merchant in `oauth2` or `scale_connect` mode. Returns the created link object including id, url, account_id, mode, expire_at, created_at. Required: mode.

get_single_airwallex_accounts_invitation_link_by_id

Get an Airwallex account invitation link by id. Returns the invitation link object including its id, url, mode, expire_at, account_id, prefilled form data, and oauth2/scale_connect parameters. Required: id (invitation link unique identifier).

create_a_airwallex_offboardings_create

Create an offboarding request for a connected account in Airwallex, initiating official account closure via an Airwallex Operations-owned case. Returns the created offboarding object including id, status, reason_code, comment, created_at, and updated_at. Required: account_id, reason_code. Only one offboarding can be in progress at a time for accounts sharing the same legal entity.

list_all_airwallex_account_offboardings

List all offboardings for a connected Airwallex account, filterable by creation date and status. Returns offboarding records with id, status, reason_code, comment, created_at, and updated_at. Required: account_id.

get_single_airwallex_account_offboarding_by_id

Get a single Airwallex offboarding by id. Returns: comment, created_at, id, reason_code, status, updated_at. Required: account_id, id.

airwallex_account_offboardings_cancel

Simulate cancelling an offboarding for a connected Airwallex account (sandbox-only endpoint). Returns the updated offboarding with status CANCELLED, including id, reason_code, comment, created_at, and updated_at. Required: account_id, offboarding_id.

airwallex_account_offboardings_complete

Simulate completing an offboarding for a connected Airwallex account (sandbox-only endpoint). Returns the updated offboarding with status COMPLETED, including id, reason_code, comment, created_at, and updated_at. Required: account_id, offboarding_id.

create_a_airwallex_program_spending_accounts_create

Create a program spending account in Airwallex under a platform liquidity program, giving a connected account access to program funds when transacting. Returns: connected_account_id, created_at, funding_source_id, id, status, updated_at. Required: platform_liquidity_program_id, connected_account_id.

create_a_airwallex_platform_liquidity_program_deposit

Deposit funds from the platform's wallet into an Airwallex platform liquidity program's settlement account, increasing the program's limit balance by the deposited amount. Returns the updated program with id, name, status, limit_balances, supported_currencies, and created_at. Required: platform_liquidity_program_id, amount, currency, request_id.

list_all_platform_liquidity_program_program_spending_accounts

List all Program Spending Accounts associated with a Platform Liquidity Program in Airwallex. Returns: items, page_after, page_before. Required: platform_liquidity_program_id and id (the program identifier).

get_platform_liquidity_program_program_spending_account_by_id

Get a single Program Spending Account under a Platform Liquidity Program in Airwallex. Returns: connected_account_id, created_at, funding_source_id, id, limit_balances, limit_policy, status, updated_at. Required: id and platform_liquidity_program_id.

list_all_airwallex_platform_liquidity_program_transactions

List the transactions that contributed to the balance of an Airwallex Platform Liquidity Program. Returns: items, page_after, page_before. Required: platform_liquidity_program_id. If no from_post_at/to_post_at range is supplied, activity defaults to a trailing 7-day window.

create_a_airwallex_program_spending_account_adjust_limit

Adjust an Airwallex program spending account's limits. Set limit_policy to ENFORCED with signed per-currency limit_adjustments, or BYPASSED to turn limits off (omit limit_adjustments). Returns the updated account: id, limit_policy, status, limit_balances, updated_at. Required: platform_liquidity_program_id, spending_account_id, limit_policy, request_id.

get_single_airwallex_platform_liquidity_program_by_id

Get a single Airwallex Platform Liquidity Program by id. Returns the program object including its id, name, status, supported currencies with low-balance thresholds, limit balances, and created_at/updated_at timestamps. Required: id.

create_a_airwallex_platform_liquidity_program_withdraw

Withdraw funds from an Airwallex platform liquidity program into the platform's wallet; the program's limit balance decreases by the withdrawn amount. Returns the updated program including id, name, status, limit_balances, supported_currencies, and supported_connected_account_regions. Required: platform_liquidity_program_id, amount, currency, request_id.

create_a_airwallex_platform_reports_create

Create a new Platform report in Airwallex. Triggers an Airwallex job to generate the report and returns its id, which can later be used to retrieve the download link once the report is ready. Requires file_format and type.

get_single_airwallex_platform_report_by_id

Retrieve an airwallex Platform report by id to obtain the report's download URL once the report is ready. Returns: id, status, type, file_format, file_name, from_created_at, to_created_at, from_updated_at, to_updated_at, download_url, download_url_expires_at, failed_reason. Required: id. The download_url expires 1 minute after generation and is only returned once status is COMPLETED.

list_all_airwallex_psp_settlement_deposits

List PSP settlement deposits in Airwallex, sorted by deposit time in descending order. Returns: amount, currency, deposit_id, deposited_at, global_account_id, holding_account_id, payer, psp_settlement_intent_id, reference, requirements, status. Filter by deposit_id, status (NEW, MATCHED, ACTION_REQUIRED), global_account_id, or deposited_at range. Page size 10–100.

airwallex_psp_settlement_intents_cancel

Cancel a PSP settlement intent in Airwallex. Returns the full intent object including id, status, currency, settlement_reference, associated_deposit_ids, and requirements. Required: psp_settlement_intent_id. The intent cannot be cancelled if it is already cancelled, matched, or settled.

list_all_airwallex_psp_settlement_intents

List PSP settlement intents created by your Airwallex account, sorted by creation time in descending order. Returns: id, associate_by_deposit_ids, associated_deposit_ids, created_at, currency, expected_settlement_date, global_account_id, metadata, request_id, requirements, settlement_reference, status.

get_single_airwallex_psp_settlement_intent_by_id

Get a single PSP settlement intent by id in Airwallex. Returns the full intent object including id, status, currency, settlement_reference, associated_deposit_ids, and requirements. Required: id.

create_a_airwallex_psp_settlement_intents_create

Create a PSP settlement intent in Airwallex — the record representing a settlement with a PSP in one currency, associated with PSP settlement deposits and later split, submitted, and matched against those deposits. Returns: id, associate_by_deposit_ids, associated_deposit_ids, created_at, currency, expected_settlement_date, global_account_id, metadata, request_id, requirements,…

create_a_airwallex_psp_settlement_intent_submit

Submit an Airwallex PSP settlement intent once all of its settlement split information has been provided, marking it ready to be matched with a PSP settlement deposit. Returns the settlement intent including id, status, currency, expected_settlement_date, settlement_reference, and requirements. Required: psp_settlement_intent_id.

update_a_airwallex_psp_settlement_intent_update_by_id

Update a PSP settlement intent in Airwallex. Returns: associate_by_deposit_ids, associated_deposit_ids, created_at, currency, expected_settlement_date, global_account_id, id, metadata, request_id, requirements, settlement_reference, status. Required: id, request_id. Values can only be updated while the intent status is NEW, ACTION_REQUIRED, or SUBMITTED.

airwallex_psp_settlement_splits_cancel

Cancel a PSP settlement split in Airwallex that has not yet been matched (e.g. if data was shared wrongly previously). After cancelling, the associated PSP settlement intent status becomes NEW; create a new split and resubmit the intent afterwards. Returns: amount, created_at, id, settlement_type, status, target_account_id. Required: psp_settlement_split_id, id.

list_all_airwallex_psp_settlement_splits

List PSP settlement splits created by your Airwallex account, sorted by creation time in descending order. Returns has_more plus a page of splits with amount, created_at, id, settlement_type, status, and target_account_id. Optional filters: created_at range, accounts, psp_settlement_intent_id, settlement_type, status. Page size 10-100.

get_single_airwallex_psp_settlement_split_by_id

Get details for a single PSP settlement split in Airwallex by its unique identifier. Returns the split's amount, created_at, id, settlement_type, status, and target_account_id. Required: id.

create_a_airwallex_psp_settlement_split_release

Release an Airwallex PSP settlement split when a seller is ready to receive funds; funds move between the holding account and the seller's connected account, with status progressing from PENDING to SETTLED. Returns: amount, created_at, id, settlement_type, status, target_account_id. Required: psp_settlement_split_id, id, request_id (1-50 characters).

create_a_airwallex_psp_settlement_intent_split

Create PSP settlement splits for an Airwallex PSP settlement intent, sharing the funds to be transferred to or from target accounts (CREDIT is a payment to the account, DEBIT a refund or chargeback). Returns: psp_settlement_intent_id, request_id. Required: psp_settlement_intent_id, request_id, and splits (each with amount, identifier, settlement_type, target_account_id). Max 2000 splits per call.

list_all_airwallex_audit_log_security_audit_logs

List security audit logs for the login account in Airwallex, covering user management, login, API key, 2FA, and credential-change activity. Returns: items, page_after, page_before. Query window defaults to from_event_time plus 180 days; earliest from_event_time is 2024-02-06T00:00:00+0800.

create_a_airwallex_account_update_status

Update the status of a connected account in the Airwallex sandbox, transitioning it to ACTION_REQUIRED, ACTIVE, or SUSPENDED. Returns the simulation account object including id, status, created_at, nickname, account_details, and requirements. Required: account_id, next_status. The connected account must be in the SUBMITTED state to transition statuses.

create_a_airwallex_payment_source_fail_next_autocharge

Simulate the failure of the next auto-charge execution for an Airwallex payment source, so you can test billing error handling and retry logic. Returns the payment source object including id, billing_customer_id, external_id, linked_payment_account_id, metadata, and created_at/updated_at timestamps. Required: payment_source_id. Only available in the Sandbox environment.

create_a_airwallex_deposit_create

Simulate a deposit into an Airwallex global account (sandbox environment only). Returns the created deposit record including id, amount, currency, create_time, deposit_type, fee_amount, fee_currency, payer_name, payer_country, status, and statement_ref. Requires amount and global_account_id; status defaults to SETTLED.

airwallex_simulation_deposits_reject

Reject a pending direct debit deposit in Airwallex, transitioning its status from PENDING to REJECTED in the sandbox simulation. Returns a boolean result of the rejection. Required: deposit_id.

create_a_airwallex_deposit_reverse

Reverse a direct debit deposit in the Airwallex sandbox: creates a new direct debit deposit in the SETTLED state with an offsetting negative amount and deactivates the Linked Account, while the original deposit remains SETTLED. Returns a boolean response. Required: deposit_id.

create_a_airwallex_deposit_settle

Settle a pending direct debit deposit in the Airwallex sandbox, transitioning its status from PENDING to SETTLED. Returns a boolean result indicating the simulation outcome. Required: deposit_id. Available in the sandbox environment only.

create_a_airwallex_card_transaction_lifecycle_capture

Capture a card transaction lifecycle in Airwallex by simulating a clearing capture against the given lifecycle ID. Returns the resulting simulation transaction including auth_code, process_result, transaction_amount, transaction_currency, merchant details, and card_id. Required: card_transaction_lifecycle_id. Available in the sandbox environment only.

create_a_airwallex_issuing_create

Create a simulated card transaction in Airwallex for a card_id or card_number; the transaction is authorized but not captured. Returns: auth_code, billing_amount, billing_currency, card_id, card_transaction_event_id, card_transaction_id, card_transaction_lifecycle_id, card_nickname, client_data, failure_reason, masked_card_number, merchant, network_transaction_id, process_result, retrieval_ref,…

create_a_airwallex_threeds_notify

Send a 3DS delegation mode notification for the provided card in Airwallex. Returns: status. Requires card_number. Only available in the sandbox environment, and the account must enable threeds delegation mode in its notification configuration.

create_a_airwallex_cardholder_pass_review

Pass the review stage of an Airwallex issuing cardholder, bypassing the Request for Information (RFI) process. Returns a boolean result. Required: cardholder_id. Only available in the sandbox environment.

create_a_airwallex_issuing_refund

Refund a card transaction in the Airwallex sandbox. Returns the simulated refund transaction including auth_code, process_result, transaction_amount, transaction_currency, masked_card_number, merchant, and card_transaction_lifecycle_id. Required: transaction_amount, transaction_currency. Only available in the sandbox environment.

create_a_airwallex_card_transaction_lifecycle_reverse

Reverse a card transaction lifecycle in Airwallex (sandbox environment only). Returns the resulting simulation transaction: type, subtype, transaction_amount, transaction_currency, process_result, and merchant details. Required: card_transaction_lifecycle_id. Omitting the amount reverses the full authorised amount; a lower amount reverses only part of it.

create_a_airwallex_mandate_accept

Accept a mandate on an Airwallex linked account via simulation, transitioning the mandate status from PROCESSING to ACTIVE. Returns a boolean result flag. Required: linked_account_id.

create_a_airwallex_mandate_cancel

Cancel an Airwallex mandate in the simulation (sandbox) environment by transitioning its status from PROCESSING or ACTIVE to INACTIVE. Returns a boolean result (example: false). Required: linked_account_id.

create_a_airwallex_linked_account_fail_microdeposit

Fail a Micro Deposits verification in Airwallex by transitioning the Linked Account status from REQUIRES_ACTION to FAILED with reason MICRO_DEPOSIT_FAILED. Returns a boolean result. Required: linked_account_id.

create_a_airwallex_mandate_reject

Reject a mandate for an Airwallex linked account in the sandbox simulation environment, transitioning the mandate status from PROCESSING to INACTIVE. Returns a boolean result. Required: linked_account_id.

create_a_airwallex_payment_disputes_create

Create a payment dispute in Airwallex for the merchant to respond to. Returns the created dispute object with id, amount, currency, stage, status, and due_at. Required: due_at, payment_intent_id, reason_code, stage.

create_a_airwallex_pa_shopper_action

Simulate a shopper action on a redirect URL from a PaymentIntent (`pay` or `reject`) or a PaymentConsent (`verify`) in Airwallex. Returns an empty 200 response on success. Required: action, url. Only available in the sandbox environment.

create_a_airwallex_payment_dispute_escalate

Escalate an Airwallex payment dispute — declines the merchant's evidence and moves the dispute to its next stage (sandbox simulation endpoint). Returns the updated dispute object including id, status, stage, amount, currency, due_at, accept_details, challenge_details, reason, and refunds. Required: payment_dispute_id and due_at.

create_a_airwallex_payment_dispute_resolve

Resolve an Airwallex payment dispute and move it to its final status — resolving in favor of MERCHANT yields WON or REVERSED, while CUSTOMER yields LOST. Returns the updated dispute object including id, status, stage, amount, and updated_at. Required: payment_dispute_id and in_favor_of (CUSTOMER or MERCHANT).

create_a_airwallex_rfi_close

Close a simulated Request for Information (RFI) in Airwallex. Returns the updated RFI session including id, account_id, status, type, sub_type, active_request, and answered_requests. Required: rfi_id. Available in the sandbox environment only.

create_a_airwallex_rfis_create

Create a simulated RFI in Airwallex for a specific type; the questions and related sources are simulated, and all RFIs for the specified type must be in CLOSED status. Returns the RFI session including id, status, type, sub_type, account_id, active_request, and answered_requests. Required: type.

create_a_airwallex_rfi_follow_up

Create a follow-up on an existing Airwallex RFI, reopening original questions by their id and/or appending new questions by expected answer type. Returns the RFI session including id, account_id, type, status, active_request, and answered_requests. Required: rfi_id.

create_a_airwallex_terminals_confirm_payment_intent

Confirm a terminal's linked payment using a specific payment scenario in the Airwallex sandbox. Returns the confirmed result including payment_intent (id, status) and terminal_id. Required: payment_scenario_name, terminal_id.

create_a_airwallex_terminals_generate_activation_code

Generate an activation code for a terminal device in the Airwallex sandbox environment; the terminal owner enters the code in the Airwallex web app to activate the device. Returns: activation_code, expires_at. Required: request_id (UUID of the request).

list_all_airwallex_terminals_payment_scenarios

List all payment scenarios supported by the Airwallex sandbox environment for in-person payment flows. Returns items, where each entry carries the scenario name and its description (e.g. mastercard_chip_no_pin).

create_a_airwallex_terminals_turn_off

Turn off a terminal device in the Airwallex sandbox simulation. Returns the terminal's status including terminal_id and connection_status. Required: terminal_id.

create_a_airwallex_terminals_turn_on

Turn on a terminal device in Airwallex via the simulation endpoint. Returns the terminal's connection_status and terminal_id once the device is connected. Required: terminal_id.

create_a_airwallex_transfer_transition

Simulate a status transition of an Airwallex transfer by moving it to a chosen status or a simulated failure. Returns the updated transfer object including id, status, failure_type, failure_reason, transfer_amount, transfer_currency, and updated_at. Required: transfer_id, next_status. Only available in the Sandbox environment.

create_a_airwallex_bills_create

Create a new bill in Airwallex. Returns the created bill including id, invoice_number, billing_amount, status, line_items, and bill_payments. Requires request_id, external_id, legal_entity_id, vendor_id, invoice_number, issued_date, due_date, billing_currency, tax_status, sync_status, and line_items (each line item needs quantity and unit_price).

list_all_airwallex_spend_bills

List Airwallex Spend bills, filterable by creation or update time range, status, sync status, legal entity, or purchase order. Returns bill records including id, invoice_number, billing_amount, status, sync_status, vendor_id, line_items, and created_at. If from_created_at is omitted, only bills created in the last 30 days are returned.

get_single_airwallex_spend_bill_by_id

Get a single Airwallex bill by id. Returns the bill object including its id, invoice_number, billing_amount, billing_currency, status, sync_status, due_date, line_items, bill_payments, and attachments. Required: id.

create_a_airwallex_bill_mark_as_paid

Mark an Airwallex bill as paid outside of Airwallex. Returns the updated bill including id, status, sync_status, billing_amount, and bill_payments. Required: bill_id.

create_a_airwallex_bill_sync

Update the sync status of an Airwallex bill. Returns the updated bill object with id, invoice_number, billing_amount, billing_currency, status, sync_status, and line_items. Required: bill_id, sync_status. sync_error_message is only applicable when sync_status is SYNC_FAILED.

list_all_airwallex_spend_expenses

List all Airwallex Spend expenses with optional filters by creation date range, status, sync status, and legal entity. Returns: items, page_after, page_before. Date filters default to the last 30 days if not specified.

get_single_airwallex_spend_expense_by_id

Get a single Airwallex Spend expense by id. Returns the full expense record including id, status, sync_status, billing_amount, merchant, card_transaction, line_items, attachments, and comments. Required: id.

create_a_airwallex_expense_sync

Update the sync status of an existing Airwallex expense. Returns the updated expense object including id, status, sync_status, billing_amount, merchant, and attachments. Required: expense_id, sync_status.

create_a_airwallex_purchase_orders_create

Create a purchase order in Airwallex. Returns the created purchase order with id, purchase_order_number, status, total_amount, contacts, and line_items. Required: request_id, external_id, legal_entity_id, vendor_id, purchase_order_number, sync_status, billing_currency, line_items (each item: quantity, unit_price).

list_all_airwallex_spend_purchase_orders

List Airwallex purchase orders filtered by created/updated time range, status, sync status, legal entity, or external id. Returns each order's id, purchase_order_number, status, total_amount, line_items, and created_at. Defaults to the last 30 days of created_at when no range is supplied.

get_single_airwallex_spend_purchase_order_by_id

Retrieve the full details of an existing Airwallex purchase order by id. Returns: id, legal_entity_id, vendor_id, billing_currency, recurring_amount, total_amount, billed_amount, purchase_order_number, external_id, status, sync_status, sync_error_message, recurrence, description, note, net_payment_terms_in_days, promise_date, approvers, owner_email, contacts, attachments, line_items, comments,…

create_a_airwallex_purchase_order_sync

Update the accounting sync status of a purchase order in Airwallex. Returns the updated purchase order including id, purchase_order_number, status, sync_status, sync_error_message, total_amount, line_items, and contacts. Required: purchase_order_id, sync_status.

list_all_airwallex_reimbursement_report_reimbursements

List all reimbursements in a specific Airwallex reimbursement report. Returns: items, page_after, page_before. Required: reimbursement_report_id.

get_single_airwallex_reimbursement_report_reimbursement_by_id

Get a single reimbursement by id within a specific Airwallex reimbursement report. Returns the full reimbursement object including id, description, merchant_name, transaction_amount, transaction_currency, billing_amount, line_items, attachments, comments, and accounting_field_selections. Required: id, reimbursement_report_id.

list_all_airwallex_spend_reimbursement_reports

List all Reimbursement Reports in Airwallex, filterable by updated-time range, status, sync status, legal entity, and approver email. Returns each report's id, name, status, sync_status, billing_currency, and created_at. Max 100 per page.

get_single_airwallex_spend_reimbursement_report_by_id

Get a single Reimbursement Report in Airwallex by id. Returns the full report including id, name, status, sync_status, approvers, comments, reimbursement_report_transfer_ids, and accounting_field_selections. Required: id.

list_all_airwallex_reimbursement_report_transfers

Get a single reimbursement report transfer in Airwallex. Returns the transfer record including its id, sync_status, account_id, beneficiary_id, and transfer_id. Required: reimbursement_report_id, transfer_id.

create_a_airwallex_reimbursement_report_mark_as_paid

Mark an Airwallex reimbursement report as paid outside of Airwallex. Returns the reimbursement report summary including id, name, status, sync_status, billing_currency, approvers, and created_at. Required: reimbursement_report_id.

create_a_airwallex_reimbursement_report_sync

Update the sync status of a reimbursement report in Airwallex. Returns the updated report summary including id, name, status, sync_status, approvers, and comments. Required: reimbursement_report_id, id, sync_status.

create_a_airwallex_transfer_sync

Update the accounting-system sync status of a transfer belonging to an Airwallex reimbursement report. Returns the updated transfer record with id, sync_status, account_id, beneficiary_id, and transfer_id. Required: reimbursement_report_id, transfer_id, and sync_status (NOT_SYNCED, SYNCED, or SYNC_FAILED).

create_a_airwallex_vendors_create

Create a vendor in Airwallex Spend. Returns the created vendor including id, name, status, sync_status, legal_entity_ids, address, contacts, and created_at. Required: request_id, external_id, name, legal_entity_ids, status, sync_status.

list_all_airwallex_spend_vendors

List Airwallex spend vendors filtered by created/updated date ranges, status, sync_status, legal_entity_id, or external_id. Returns: items, page_after, page_before. Date filters default to the last 30 days when omitted.

get_single_airwallex_spend_vendor_by_id

Get a single Airwallex spend vendor by id. Returns the full vendor record including id, name, business_name, address, status, sync_status, approvers, contacts, attachments, and comments. Required: id.

create_a_airwallex_vendor_sync

Update the sync status of an Airwallex vendor in an accounting system. Returns the full vendor object including id, name, status, sync_status, and sync_error_message. Required: vendor_id and sync_status; sync_error_message only applies when sync_status is SYNC_FAILED.

list_all_airwallex_ecosystem_connected_stores

List all Connected Stores in Airwallex, optionally filtered by created_at time range. Returns each store's id, name, platform, status, url, default_currency, and platform_seller_id.

get_single_airwallex_ecosystem_connected_store_by_id

Get a single Airwallex Connected Store by its unique identifier. Returns the store's id, name, platform, status, url, default_currency, and platform_seller_id. Required: id.

create_a_airwallex_files_download_link

Create download links for Airwallex files by submitting their identifiers. Returns: absent_files, files. Supply file_ids. Links expire after 1 day; files must not exceed 20MB.

create_a_airwallex_files_upload

Upload a file to Airwallex and receive its unique identifier, which can be referenced as part of the attachments object in other endpoints. Returns: created, file_id, filename, notes, object_type, size. Required: file. Max upload size is 20MB.

list_all_airwallex_reference_industry_categories

List Airwallex industry categories as a tree of classification codes and questions used to determine a business's industry. Returns: answer, name, question, type, value, values.

list_all_airwallex_reference_invalid_conversion_dates

List Airwallex invalid conversion dates for a specified currency pair. Returns: currency_pair, invalid_conversion_dates. Required: currency_pair (defaults to AUDUSD).

list_all_airwallex_reference_supported_currencies

List the client-specific Airwallex currencies that can be bought or sold. Returns a conversion object with buy_currencies and sell_currencies arrays of ISO currency codes (e.g. AUD, USD). No parameters required.

list_all_airwallex_order_items_expiring_quotas

Retrieve the Airwallex transfer or deposit limit that is about to expire in the next week. Returns: currency, expire_by, expiring_order_amount. Optional: type (defaults to CN_INBOUND).

list_all_airwallex_order_items_quotas

Get the available transfer or deposit limit for an Airwallex account. Returns: available_order_amount, currency, history_order_amount.

create_a_airwallex_order_items_upload

Upload cross-border sales order items to Airwallex to increase transfer or deposit limits. Accepts up to 500 items per request; each item requires category, currency, item_name, item_quantity, item_unit_price, item_url, line_total, order_datetime, order_id, shipment_provider, and shipment_tracking_number. Returns a JSON object; upstream docs do not enumerate its fields. CN_INBOUND must be enabled…

create_a_airwallex_conversions_create

Create a new FX conversion to be executed within an Airwallex wallet. Returns the created conversion including conversion_id, status, buy_amount, sell_amount, client_rate, and currency_pair. Required: buy_currency, sell_currency, request_id, and exactly one of buy_amount or sell_amount (the dealt side); the minimum conversion is USD $1.

list_all_airwallex_fx_conversions

List all FX conversions in Airwallex, returned most recent first. Returns each conversion's conversion_id, currency_pair, buy/sell amounts and currencies, awx_rate/client_rate/mid_rate, rate_details, status, short_reference_id, and created_at/updated_at. All filters are optional; with no date range the last 31 days are returned.

get_single_airwallex_fx_conversion_by_id

Get a single Airwallex FX conversion by id (the Airwallex conversion_id). Returns the full conversion including conversion_id, currency_pair, buy_amount, sell_amount, dealt_currency, awx_rate/client_rate/mid_rate, rate_details, funding details, status, and created_at. Required: id.

create_a_airwallex_conversion_amendments_create

Create an amendment on a booked but unsettled Airwallex FX conversion — currently only full cancellation (`type: CANCEL`) is supported. Returns the created amendment including amendment_id, charges, conversion_id, metadata, short_reference_id, created_at, and updated_at. Requires conversion_id, request_id, and type.

list_all_airwallex_fx_conversion_amendments

List all conversion amendments in Airwallex associated with a given conversion. Returns: has_more, items. Required: conversion_id. Since only full cancellations are supported, a conversion has at most one amendment.

get_single_airwallex_fx_conversion_amendment_by_id

Get a single Airwallex conversion amendment by id. Returns the amendment including amendment_id, charges, conversion_id, created_at, type, and updated_at. Required: id (the amendment's unique identifier, amendment_id).

create_a_airwallex_conversion_amendments_quote

Create an amendment quote on a booked but unsettled conversion in Airwallex to get an indicative quote for the charge fee. Returns: charges, conversion_id, metadata, request_id, short_reference_id, type. Required: conversion_id, request_id, type. Only type CANCEL is supported.

create_a_airwallex_quotes_create

Create an FX quote in Airwallex to lock in a guaranteed exchange rate for an agreed period. Returns: application_fees, awx_rate, buy_amount, buy_currency, client_rate, conversion_date, currency_pair, dealt_currency, mid_rate, quote_id, rate_details, sell_amount, sell_currency, usage, valid_from_at, valid_to_at, validity. Required: buy_currency, sell_currency, validity. Specify either buy_amount…

get_single_airwallex_fx_quote_by_id

Get a specific Airwallex FX quote by id. Returns the full quote object including quote_id, currency_pair, buy/sell amounts and currencies, awx_rate, client_rate, mid_rate, application_fees, rate_details, usage, validity, and the valid_from_at/valid_to_at window. Required: id (the quote_id UUID).

list_all_airwallex_fx_rates

Retrieve the current Airwallex FX rate for a currency pair, validated against the upper conversion limit for the requested amount. Returns: buy_currency, conversion_date, created_at, currency_pair, dealt_currency, rate, rate_details, sell_currency. Required: buy_currency, sell_currency. Specify either buy_amount or sell_amount, not both.

list_all_airwallex_webhooks

List all Airwallex webhooks. Returns: id, url, secret, version, events, created_at, updated_at, request_id.

get_single_airwallex_webhook_by_id

Get a single Airwallex webhook by id. Returns the webhook object including its id, url, secret, subscribed events, created_at, and request_id. Required: id.

create_a_airwallex_webhook

Create a new Airwallex webhook that subscribes to a list of webhook events. Returns the created webhook including its id, url, secret, events, created_at, and request_id. Requires url, version, events, and request_id. Events cannot be modified after creation.

delete_a_airwallex_webhook_by_id

Delete an Airwallex webhook by id; a deleted webhook no longer receives webhook events of any Airwallex organisations or accounts. Returns: id, deleted. Required: webhook_id.

update_a_airwallex_webhook_by_id

Update an existing Airwallex webhook; only updates to url are currently supported. Returns the updated webhook including its id, url, secret, events, created_at, and request_id. Required: webhook_id and url.

get_single_airwallex_connected_account_by_id

Get a single connected Airwallex account by id. Returns the full account object including id, status, account_details, customer_agreements, primary_contact, and next_action. Required: id.

list_all_airwallex_connected_accounts

List all accounts connected to your Airwallex platform. Returns connected account objects including id, status, account_details, identifier, and created_at. The list is empty if you are not a platform.

create_a_airwallex_billing_customer

Create a billing customer in Airwallex. Returns the created customer object including id, name, email, type, address, default_billing_currency, automatic_tax_eligibility, and created_at. Requires request_id; type defaults to BUSINESS when tax_identification_number is present, otherwise INDIVIDUAL.

update_a_airwallex_billing_customer_by_id

Update a billing customer in Airwallex by id; only fields provided in the body are changed and omitted fields remain unchanged. Returns the updated customer object including id, name, email, type, address, default_billing_currency, and updated_at. Required: id.

create_a_airwallex_coupon

Create a new coupon in Airwallex that can be redeemed in purchases. Returns the created coupon including its id, name, discount_model, amount_off, percentage_off, duration, and times_redeemed. Required: name, request_id, discount_model, duration_type; duration is required when duration_type is CUSTOM.

get_single_airwallex_coupon_by_id

Get a single Airwallex coupon by id. Returns the coupon object including its id, name, discount_model, amount_off, percentage_off, duration_type, duration, active, and times_redeemed. Required: id.

list_all_airwallex_coupons

List Airwallex coupons, optionally filtered by active status, discount model, duration type, and creation or expiry date ranges. Returns: active, amount_off, created_at, currency, description, discount_model, duration, duration_type, expires_at, id, metadata, name, percentage_off, times_redeemed, updated_at. Max 1000 per page.

update_a_airwallex_coupon_by_id

Update an Airwallex coupon by id. Returns the updated coupon object including id, name, active, discount_model, amount_off, percentage_off, duration, and expires_at. Required: id. All fields can be adjusted before first redemption; after redemption only name, description, expires_at, and metadata can be changed.

create_a_airwallex_payment_source

Create a payment source in Airwallex from a payment method of a supported Payment Service Provider (e.g. a PaymentMethod authorized for merchant-initiated payments via Airwallex Payments). Returns: billing_customer_id, created_at, external_id, id, linked_payment_account_id, metadata, updated_at. Requires billing_customer_id, external_id, and request_id.

get_single_airwallex_payment_source_by_id

Get a single Airwallex payment source by id. Returns: billing_customer_id, created_at, external_id, id, linked_payment_account_id, metadata, updated_at. Required: id.

list_all_airwallex_payment_sources

List Airwallex billing payment sources. Returns each payment source's id, billing_customer_id, external_id, linked_payment_account_id, metadata, created_at, and updated_at.

create_a_airwallex_price

Create a new Price object in Airwallex. Returns the created price including id, currency, pricing_model, unit_amount, recurring, tiers, and type. Requires currency, product_id, and request_id.

get_single_airwallex_price_by_id

Get the details of a single Airwallex Price by id. Returns: id, active, billing_type, created_at, currency, description, flat_amount, lot, metadata, meter_id, metered, pricing_model, product_id, recurring, tax_included, tiers, unit_amount, unit_description, updated_at. Required: id.

list_all_airwallex_prices

List Airwallex Prices, optionally filtered by active status, currency, product_id, or recurring billing frequency. Returns: id, active, billing_type, created_at, currency, description, flat_amount, lot, metadata, meter_id, metered, pricing_model, product_id, recurring, tax_included, tiers, unit_amount, unit_description, updated_at.

update_a_airwallex_price_by_id

Update an Airwallex Price by id; only the fields provided in the request are changed and omitted fields remain unchanged. Returns: id, active, billing_type, created_at, currency, description, flat_amount, lot, metadata, meter_id, metered, pricing_model, product_id, recurring, tax_included, tiers, unit_amount, unit_description, updated_at. Required: id.

create_a_airwallex_product

Create a Product in Airwallex billing. Returns the created product including id, name, description, tax_code, unit, active, and created_at. Requires name and request_id.

get_single_airwallex_product_by_id

Get a Product in Airwallex billing by id. Returns the full product object including id, name, description, tax_code, unit, active, created_at, and updated_at. Required: id.

list_all_airwallex_products

List Products in Airwallex billing. Returns product records including id, name, description, tax_code, unit, active, and created_at; optionally filter by active.

update_a_airwallex_product_by_id

Update a Product in Airwallex billing by id. Only fields provided in the request are updated; omitted fields remain unchanged. Returns the updated product including id, name, description, tax_code, unit, active, and updated_at. Required: id.

airwallex_usage_events_batch_ingest

Ingest up to 10 usage events in a single batch in Airwallex. The events are validated and processed asynchronously; if errors occur, webhook events are published. Requires an events array where each event must include billing_customer_id, event_name, merchant_event_id, and properties. Returns an empty 202 Accepted response on success.

airwallex_usage_events_ingest

Ingest a single usage event in Airwallex. Returns the created usage event including billing_customer_id, event_name, merchant_event_id, happened_at, ingested_at, properties, and voided status. Requires billing_customer_id, event_name, merchant_event_id, and properties. The event is validated synchronously but processed asynchronously; for higher rate limits use batch_ingest instead.

airwallex_usage_events_void

Void a previously ingested usage event in Airwallex. Requires merchant_event_id, the unique identifier of the event to void, and the event must have been ingested within the past 35 days. Returns an empty 202 Accepted response on success.

create_a_airwallex_accounting_field

Create a new custom accounting field for Airwallex Spend. Returns the created field including id, name, name_label, status, created_at, and updated_at. Requires request_id (UUID for idempotency) and name.

get_single_airwallex_accounting_field_by_id

Get a single custom accounting field used in Airwallex Spend by id. Returns: id, name, name_label, status, created_at, updated_at. Required: id.

list_all_airwallex_accounting_fields

List all custom accounting fields used in Airwallex Spend. Returns: id, name, name_label, status, created_at, updated_at. Max 100 per page.

update_a_airwallex_accounting_field_by_id

Update an existing custom accounting field used in Airwallex Spend by id. Returns the updated field including id, name, name_label, status, created_at, and updated_at. Requires id and name.

create_a_airwallex_accounting_field_value

Create a new accounting field value in Airwallex Spend. Returns the created value with id, accounting_field_id, value, value_label, external_id, legal_entity_ids, status, created_at, and updated_at. Required: request_id, accounting_field_id, value.

get_single_airwallex_accounting_field_value_by_id

Get an accounting field value by id in Airwallex Spend. Returns: id, accounting_field_id, value, value_label, external_id, legal_entity_ids, status, created_at, updated_at. Required: id.

list_all_airwallex_accounting_field_values

List accounting field values in Airwallex Spend, filtered by the specified query parameters. Returns records with id, accounting_field_id, value, value_label, external_id, legal_entity_ids, status, created_at, and updated_at. Supports optional filters accounting_field_id, status, external_id, and legal_entity_id.

update_a_airwallex_accounting_field_value_by_id

Update an existing accounting field value in Airwallex Spend. Returns the updated value with id, accounting_field_id, value, value_label, external_id, legal_entity_ids, status, created_at, and updated_at. Required: id, accounting_field_id, value, status.

delete_a_airwallex_batch_transfer_delete_item_by_id

Delete invalid or wrong items within a draft Airwallex batch transfer, before it is submitted. Returns the updated batch transfer object including id, status, total_item_count, valid_item_count, name, quote_summary, and funding. Required: batch_transfer_id, item_ids. Only allowed while the batch transfer status is DRAFTING.