Airwallex API
Airwallex Client Api Documentation.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Airwallex Client Api Documentation.
Endpoints 400
Account Capability > Account Capability
- POST3|Enable an Account Capability
/api/v1/account_capabilities/:id/enableSubmit a request to enable a specific capability for your Airwallex account. - GET4|List all Funding Limits
/api/v1/account_capabilities/funding_limitsBefore initiating a Direct Debit from a Linked Account or as a Funding Source, you may wish to query the available funding limit or Faster Direct Debit limit. - GET1|Retrieve an Account Capability
/api/v1/account_capabilities/:idGet the status of a capability by providing the capability unique identifier.
Accounting > General Ledger Accounts
- POST1|Create a General Ledger Account
/api/v1/accounting/gl_accounts/createCreates a new General Ledger (GL) account for coding Airwallex Spend transactions. - GET3|List all General Ledger Accounts
/api/v1/accounting/gl_accountsReturns General Ledger (GL) accounts used in Airwallex Spend, filtered by the specified query parameters. - GET2|Retrieve a General Ledger Account
/api/v1/accounting/gl_accounts/:idRetrieves an existing General Ledger (GL) account used in Airwallex Spend. - POST4|Update a General Ledger Account
/api/v1/accounting/gl_accounts/:id/updateUpdates an existing General Ledger (GL) account used in Airwallex Spend.
Accounting > Tax Codes
- POST1|Create a Tax Code
/api/v1/accounting/tax_codes/createCreates a new tax code for coding Airwallex Spend transactions. - GET3|List all Tax Codes
/api/v1/accounting/tax_codesReturns tax codes used in Airwallex Spend, filtered by the specified query parameters. - GET2|Retrieve a Tax Code
/api/v1/accounting/tax_codes/:idRetrieves an existing tax code used in Airwallex Spend. - POST4|Update a Tax Code
/api/v1/accounting/tax_codes/:id/updateUpdates an existing tax code used in Airwallex Spend.
Accounting > Accounting Fields
- POST1|Create an Accounting Field
/api/v1/accounting/accounting_fields/createCreates a new custom accounting field for Airwallex Spend. - GET3|List all Accounting Fields
/api/v1/accounting/accounting_fieldsReturns custom accounting fields used in Airwallex Spend. - GET2|Retrieve an Accounting Field
/api/v1/accounting/accounting_fields/:idRetrieves an existing custom accounting field used in Airwallex Spend. - POST4|Update an Accounting Field
/api/v1/accounting/accounting_fields/:id/updateUpdates an existing custom accounting field used in Airwallex Spend.
Accounting > Accounting Field Values
- POST1|Create an Accounting Field Value
/api/v1/accounting/accounting_field_values/createCreates a new accounting field value for coding Airwallex Spend transactions. - GET3|List all Accounting Field Values
/api/v1/accounting/accounting_field_valuesReturns accounting field values used in Airwallex Spend, filtered by the specified query parameters. - GET2|Retrieve an Accounting Field Value
/api/v1/accounting/accounting_field_values/:idRetrieves an existing accounting field value used in Airwallex Spend. - POST4|Update an Accounting Field Value
/api/v1/accounting/accounting_field_values/:id/updateUpdates an existing accounting field value used in Airwallex Spend.
Authentication > Embedded Components
- POST1|Authorize an Account
/api/v1/authentication/authorizeAuthorize the platform itself, or a connected account with header x-on-behalf-of to use embedded components. Platforms can embed core Airwallex…
Authentication > Authentication
- POST1|Obtain Access Token
/api/v1/authentication/loginObtain an access token by specifying your x-client-id and x-api-key in the HTTP request header. Include the access token you receive in the Authorization:…
Billing > Credit Notes
- POST9|Create Credit Note Line Items and Add Them to a Credit Note
/api/v1/billing/credit_notes/:id/add_line_itemsCreate Line Items and add them to a Credit Note. This is only possible when the Credit Note status is DRAFT. You can only add 100 line items at a time. The… - POST1|Create a Credit Note
/api/v1/billing/credit_notes/createCreate a Credit Note that is linked to an Invoice. - POST7|Delete a Credit Note
/api/v1/billing/credit_notes/:id/deleteDelete a draft Credit Note. - POST13|Delete Credit Note Line Items From a Credit Note
/api/v1/billing/credit_notes/:id/delete_line_itemsDelete Line Items in a Credit Note. This is only possible when the Credit Note status is DRAFT. You can only delete 100 line items at a time. The bulk delete… - POST6|Finalize a Credit Note
/api/v1/billing/credit_notes/:id/finalizeFinalize a draft Credit Note. If the type is BEFORE_PAYMENT, the refund_amount and out_of_band_amount must be null. If the type is AFTER_PAYMENT, you will… - GET3|List all Credit Notes
/api/v1/billing/credit_notesRetrieve a list of Credit Notes based on the query parameters. - GET11|List all Credit Note Line Items
/api/v1/billing/credit_notes/:id/line_itemsRetrieves a list of Credit Note Line Items based on the query parameters. - POST5|Preview a Credit Note
/api/v1/billing/credit_notes/previewPreview a Credit Note that is linked to an Invoice. - GET2|Retrieve a Credit Note
/api/v1/billing/credit_notes/:idRetrieves the details of a Credit Note. - GET10|Retrieve a Credit Note Line Item
/api/v1/billing/credit_notes/:id/line_items/:line_item_idRetrieves the details of a Credit Note Line Item. - POST4|Update a Credit Note
/api/v1/billing/credit_notes/:id/updateUpdate a draft Credit Note. - POST12|Update Credit Note Line Items in a Credit Note
/api/v1/billing/credit_notes/:id/update_line_itemsUpdate Line Items in a Credit Note. This is only possible when the Credit Note status is DRAFT. You can only update 100 line items at a time. The bulk update… - POST8|Void a Credit Note
/api/v1/billing/credit_notes/:id/voidVoid a finalized Credit Note. Transition from finalized to voided is allowed only when: 1) type of Credit Note is pre-payment 2) payment status of the linked…
Billing > Billing Checkouts
- POST5|Cancel a Billing Checkout
/api/v1/billing/billing_checkouts/:id/cancelA Billing Checkout in ACTIVE status can be cancelled. Once cancelled, the customer will no longer be able to complete the checkout and will see an error… - POST1|Create a Billing Checkout
/api/v1/billing/billing_checkouts/createCreates a Billing Checkout object. - GET3|List all Billing Checkouts
/api/v1/billing/billing_checkoutsRetrieves a list of Billing Checkouts based on the query parameters. - GET2|Retrieve a Billing Checkout
/api/v1/billing/billing_checkouts/:idRetrieves a Billing Checkout. - POST4|Update a Billing Checkout
/api/v1/billing/billing_checkouts/:id/updateUpdates a Billing Checkout object.
Billing > Billing Customers
- POST1|Create a Billing Customer
/api/v1/billing/billing_customers/createCreates a Billing Customer. - GET4|List all Billing Customers
/api/v1/billing/billing_customersRetrieves a list of Billing Customers based on the query parameters. - GET3|Retrieve Bank Transfer Instructions of a Billing Customer
/api/v1/billing/billing_customers/:id/bank_transfer_instructionsRetrieves the bank transfer instructions of a Billing Customer as a read-only list, with one entry per supported currency. The list is empty until bank… - GET2|Retrieve a Billing Customer
/api/v1/billing/billing_customers/:idRetrieves the details of a Billing Customer. - POST5|Update a Billing Customer
/api/v1/billing/billing_customers/:id/updateUpdates a Billing Customer. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if…
Billing > Billing Transactions
- GET2|List all Billing Transactions
/api/v1/billing/billing_transactionsRetrieves a list of Billing Transactions based on the query parameters. - GET1|Retrieve a Billing Transaction
/api/v1/billing/billing_transactions/:idRetrieves the details of a Billing Transaction.
Billing > Coupons
- POST1|Create a Coupon
/api/v1/billing/coupons/createCreates a new coupon template that can be redeemed in purchases. - GET3|List all Coupons
/api/v1/billing/couponsGet a list of coupons. - GET2|Retrieve a Coupon
/api/v1/billing/coupons/:idRetrieves the coupon details by the ID. - POST4|Update a Coupon
/api/v1/billing/coupons/:id/updateUpdates a coupon. Before first redemption, all fields can be adjusted; after redemption, only non-billing fields (name, description, expires_at, metadata) can…
Billing > Invoices
- POST11|Create Invoice Line Items and Add Them to an Invoice
/api/v1/billing/invoices/:id/add_line_itemsThis is only possible when the status of an Invoice is in DRAFT. You can add up to 100 line items at a time. This bulk operation is atomic. - POST1|Create an Invoice
/api/v1/billing/invoices/createCreates a one-off Invoice. - POST9|Delete a Draft Invoice
/api/v1/billing/invoices/:id/deleteDelete a draft Invoice. - POST15|Delete Invoice Line Items Within an Invoice
/api/v1/billing/invoices/:id/delete_line_itemsThis is only possible when the status of an Invoice is in DRAFT. You can delete up to 100 line items at a time. This bulk operation is atomic. - POST6|Finalize an Invoice
/api/v1/billing/invoices/:id/finalizeFinalizes a draft invoice. - GET3|List all Invoices
/api/v1/billing/invoicesRetrieves a list of Invoices based on the query parameters. - GET17|List all Invoice Line Item Groups
/api/v1/billing/invoices/:id/line_item_groupsRetrieves a list of line item groups for an Invoice. - GET13|List all Invoice Line Items
/api/v1/billing/invoices/:id/line_itemsRetrieves a list of Invoice Line Items based on the query parameters. - POST7|Mark an Invoice As Paid
/api/v1/billing/invoices/:id/mark_as_paidMark a finalized Invoice that has already been paid out-of-band. - POST8|Pay an Invoice
/api/v1/billing/invoices/:id/payPay a finalized AUTO_CHARGE Invoice using an existing Payment Source. - POST5|Preview an Invoice
/api/v1/billing/invoices/previewPreview the upcoming invoice of an existing Subscription, including proposed updates when update parameters are provided, or the first invoice of a new… - GET2|Retrieve an Invoice
/api/v1/billing/invoices/:idRetrieves the details of an Invoice. - GET12|Retrieve an Invoice Line Item
/api/v1/billing/invoices/:id/line_items/:item_idRetrieves the details of a line item on an Invoice. - GET16|Retrieve an Invoice Line Item Group
/api/v1/billing/invoices/:id/line_item_groups/:group_idRetrieves the details of a line item group on an Invoice. - POST4|Update an Invoice
/api/v1/billing/invoices/:id/updateUpdates a draft Invoice. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included.… - POST14|Update Invoice Line Items in an Invoice
/api/v1/billing/invoices/:id/update_line_itemsThis is only possible when the status of an Invoice is in DRAFT. You can update up to 100 line items at a time. This bulk operation is atomic. - POST10|Void an Invoice
/api/v1/billing/invoices/:id/voidVoid a finalized Invoice.
Billing > Meters
- POST6|Archive a Meter
/api/v1/billing/meters/:id/archiveArchive a Meter. The meter will no longer be available to be linked to new Prices. It can be archived only when there is no linked active price. - POST1|Create a Meter
/api/v1/billing/meters/createCreate a new Meter object. - GET3|List all Meters
/api/v1/billing/metersRetrieves a list of Meters based on the query parameters. - GET7|Retrieve Summaries of a Meter
/api/v1/billing/meters/:id/summaries?billing_customer_id=string&from_happened_at=2024-01-01T00:00:00Z&to_happened_at=2024-01-01T00:00:00ZCalculates the result of a Meter for a customer for a given time period. - POST5|Restore a Meter
/api/v1/billing/meters/:id/restoreRestore a Meter. The meter will be available to be linked to new Prices. - GET2|Retrieve a Meter
/api/v1/billing/meters/:idRetrieves the details of a Meter. - POST4|Update a Meter
/api/v1/billing/meters/:id/updateUpdate a meter.
Billing > Payment Sources
- POST1|Create a Payment Source
/api/v1/billing/payment_sources/createCreates a PaymentSource using a linked payment method from a supported Payment Service Provider (PSP). When Airwallex Payments is used as the PSP, you can… - GET3|List all Payment Sources
/api/v1/billing/payment_sourcesRetrieves a list of Payment Sources based on the query parameters. - GET2|Retrieve a Payment Source
/api/v1/billing/payment_sources/:idRetrieves the details of a Payment Source.
Billing > Prices
- POST1|Create a Price
/api/v1/billing/prices/createCreate a new Price object. - GET3|List all Prices
/api/v1/billing/pricesRetrieves a list of Prices based on the query parameters. - GET2|Retrieve a Price
/api/v1/billing/prices/:idRetrieves the details of a Price object by the ID. - POST4|Update a Price
/api/v1/billing/prices/:id/updateUpdates a Price by setting the values of the request parameters. Any parameters not provided will be left unchanged. Only fields provided in the request are…
Billing > Products
- POST1|Create a Product
/api/v1/billing/products/createCreates a new Product object. - GET3|List all Products
/api/v1/billing/productsRetrieves a list of Products based on the query parameters. - GET2|Retrieve a Product
/api/v1/billing/products/:idRetrieves the product details by the ID. - POST4|Update a Product
/api/v1/billing/products/:id/updateUpdates a Product. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a…
Billing > Subscriptions
- POST5|Cancel a Subscription
/api/v1/billing/subscriptions/:id/cancelCancels a Subscription immediately and refunds based on specified proration behavior. - POST1|Create a Subscription
/api/v1/billing/subscriptions/createCreate a new Subscription for an existing Billing Customer to charge the customer on a recurring basis. - GET3|List all Subscriptions
/api/v1/billing/subscriptionsRetrieves a list of Subscriptions based on the query parameters. - GET7|List all Subscription Items
/api/v1/billing/subscriptions/:id/itemsRetrieves a list of Subscription Items based on the query parameters. - GET2|Retrieve a Subscription
/api/v1/billing/subscriptions/:idRetrieves the details of a Subscription using the given Subscription ID. - GET6|Retrieve a Subscription Item
/api/v1/billing/subscriptions/:id/items/:item_idRetrieves the details of a Subscription Item. - POST4|Update a Subscription
/api/v1/billing/subscriptions/:id/updateUpdates a Subscription. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included.…
Billing > Usage Events
- POST2|Batch Ingest Usage Events
/api/v1/billing/usage_events/batch_ingestIngest new usage events in a batch. The events are validated and processed asynchronously. If errors occur, webhook events will be published. Maximum 10… - POST1|Ingest a Usage Event
/api/v1/billing/usage_events/ingestIngest a single usage event. The event is validated synchronously, but is processed asynchronously. For higher rate limits, please use the Batch Ingest Usage… - POST3|Void a Usage Event
/api/v1/billing/usage_events/voidVoid a previous usage event ingested within 35 days.
Confirmation Letter > Confirmation Letter
- POST1|Create a Confirmation Letter
/api/v1/confirmation_letters/createGiven a transaction id , to generate confirmation letter , return as file stream, currently support deposit and payment.
Core Resources > Direct Debits
- POST3|Cancel a Direct Debit
/api/v1/direct_debits/:transaction_id/cancelCancel a direct debit by transaction id. - GET2|List all Direct Debits
/api/v1/direct_debitsGet list of direct debits by specifying the start and end date/time of creation. If neither from_created_date nor to_created_date are provided, direct debits… - GET1|Retrieve a Direct Debit
/api/v1/direct_debits/:transaction_idGet direct debit by transaction id.
Core Resources > Balances
- GET1|List all Current Balances
/api/v1/balances/currentGet *available* and *pending* balances for every currency. - GET2|Retrieve the Balance History
/api/v1/balances/historyGet balance history for an account based on the transaction currency. The response contains records where each record represents a change to the balance. You…
Core Resources > Deposits
- POST1|Create a Deposit Via Direct Debit
/api/v1/deposits/createDeposits funds into your Airwallex account via Direct Debit from a Linked Account. - GET3|List all Deposits
/api/v1/depositsReturns a list of deposits made into your Airwallex wallet. You can filter the list by specifying a time period. If left unspecified or only the end date is… - GET2|Retrieve a Deposit
/api/v1/deposits/:idRetrieves details of a deposit using the given deposit unique identifier.
Core Resources > Global Accounts
- GET9|List all Aliases
/api/v1/global_accounts/:global_account_id/aliasesRetrieves a list of aliases registered to a given Global Account. - POST13|Cancel an Alias for a Global Account
/api/v1/global_accounts/:global_account_id/aliases/:id/cancelCancels an alias for a Global Account. Once cancelled, the alias can no longer be used for any transactions, such as receiving funds. - POST6|Close a Global Account
/api/v1/global_accounts/:id/closeClose a global account created under your Airwallex account. - POST1|Create a Global Account
/api/v1/global_accounts/createSubmit a request to create a new global account in your chosen currency. This global account can be used for the purpose of receiving funds from your payers… - POST7|Create an Alias for a Global Account
/api/v1/global_accounts/:global_account_id/aliases/createCreates an alias for a Global Account to receive funds. Supported alias types include: EMAIL, PHONE_NUMBER, and AUSTRALIAN_BUSINESS_NUMBER. For alias types… - POST5|Generate Global Account Statement
/api/v1/global_accounts/:id/generate_statement_letterGenerate global account statement letter, return as file stream. - POST10|Initiate an Alias Port for a Global Account
/api/v1/global_accounts/:global_account_id/aliases/:id/initiate_portInitiates an alias port to transfer the alias details to a different Airwallex Global Account or to another external bank account. After you submit the… - GET3|List all Global Accounts
/api/v1/global_accountsGet list of global accounts created by your Airwallex account. - GET15|List all Direct Debit Payout Mandates
/api/v1/global_accounts/:global_account_id/mandatesGet a list of Direct Debit Payout Mandates by an Airwallex global account id. - GET17|List all Global Account Transactions
/api/v1/global_accounts/:id/transactionsObtain transaction details of funds received into your specified global account. - POST16|Cancel a Direct Debit Payout Mandate
/api/v1/global_accounts/:global_account_id/mandates/:id/cancelCancel a Direct Debit Payout Mandate by an Airwallex global account id and mandate id. - POST12|Request New Alias Verification Code
/api/v1/global_accounts/:global_account_id/aliases/:id/request_new_verification_codeRequests new verification code for an alias to complete the alias creation process. - GET2|Retrieve a Global Account
/api/v1/global_accounts/:idGet global account by an Airwallex global account id. - GET8|Retrieve an Alias
/api/v1/global_accounts/:global_account_id/aliases/:idRetrieves details of an alias using the given alias ID. - GET14|Retrieve a Direct Debit Payout Mandate
/api/v1/global_accounts/:global_account_id/mandates/:idGet a Direct Debit Payout Mandate by an Airwallex global account id and mandate id. - POST11|Submit Alias Verification Code
/api/v1/global_accounts/:global_account_id/aliases/:id/submit_verification_codeSubmits the verification code (received via email or SMS) to complete the alias creation process. If the code has expired or the verification attempt limit is… - POST4|Update an Existing Global Account
/api/v1/global_accounts/:id/updateEdit an existing global account nick_name, deposit_conversion_currency or alternate_account_identifiers stored on the Airwallex platform.
Core Resources > Linked Accounts
- POST4|Generate a Linked Account Authentication
/api/v1/linked_accounts/authGenerates a Linked Account authentication. You will retrieve an authentication token with the specified Open Banking provider to verify the ownership of the… - POST10|Complete the Authentication Refresh
/api/v1/linked_accounts/:id/complete_authCompletes the authentication refresh. After the refresh authentication process is confirmed, the corresponding Linked Account status will become SUCCEEDED. - POST9|Confirm a Linked Account Among Candidate Accounts
/api/v1/linked_accounts/:id/confirmConfirm your Linked Account among a list of candidate accounts that have already been verified. - POST1|Create a Linked Account
/api/v1/linked_accounts/createLinks an external bank account to your Airwallex account. If you would like to use Open Banking as your verification method, please first call on the… - GET3|List all Linked Accounts
/api/v1/linked_accountsReturns a list of Linked Accounts associated with a specific Airwallex account. - GET7|Check Available Balances
/api/v1/linked_accounts/:id/balancesRetrieves the balance of a Linked Account using the given Linked Account unique identifier. This API is only available to Linked Accounts where… - POST5|Refresh a Linked Account Authentication
/api/v1/linked_accounts/:id/authRefreshes a Linked Account authentication after it has expired. You can call /complete_auth in onSuccess callback from the Open Banking provider to inform… - GET2|Retrieve a Linked Account
/api/v1/linked_accounts/:idRetrieves details of a Linked Account using the given Linked Account unique identifier. - GET11|Retrieve a Direct Debit Deposit Mandate
/api/v1/linked_accounts/:id/mandateRetrieves the mandate of a Linked Account using the given Linked Account unique identifier. - POST12|Update a Direct Debit Deposit Mandate
/api/v1/linked_accounts/:id/mandateAdds a mandate to the Linked Account, if it was not provided at the time of creation, or renews an existing mandate. The external bank account owner must sign… - POST8|Suspend a Linked Account
/api/v1/linked_accounts/:id/suspendSuspend the link between your external bank account and your Airwallex account. This will also revoke any mandate objects attached to your Linked Account. To… - POST6|Verify Linked Account with Micro-deposits
/api/v1/linked_accounts/:id/verify_microdepositsVerifies your Linked Account using the micro-deposit amounts received in the Linked Account.
Finance > Financial Reports
- POST1|Create a Financial Report
/api/v1/finance/financial_reports/createCreate a balance activity, transaction reconciliation, or settlement report. - GET3|List all Financial Reports
/api/v1/finance/financial_reportsGet list of previously generated balance activity, transaction reconciliation, settlement, account statement, and aggregated settlement reports. - GET4|Retrieve a Contents of a Financial Report
/api/v1/finance/financial_reports/:id/contentDownload a previously generated balance activity, transaction reconciliation, settlement or aggregated settlement reports. - GET2|Retrieve a Financial Report
/api/v1/finance/financial_reports/:idGet a single generated balance activity, transaction reconciliation, settlement or aggregated settlement report.
Finance > Financial Transactions
- GET2|List all Financial Transactions
/api/v1/financial_transactionsGet a list of financial transactions that contributed to the Airwallex account balance from a specified creation date/time, with optional filters on end… - GET1|Retrieve a Financial Transaction
/api/v1/financial_transactions/:idGet a specific financial transaction by an Airwallex financial transaction unique identifier.
Finance > Settlements
- GET2|List all Settlements
/api/v1/pa/financial/settlements?currency=CNY&from_settled_at=2017-04-01&status=PENDING&to_settled_at=2017-04-01Get list of settlements that contributed to the Airwallex account balance from a specified settled date, with optional filters on end settled date, currency… - GET3|Retrieve a Settlement Report
/api/v1/pa/financial/settlements/:id/reportGet a single batch settlement report by specifying the Airwallex settlement batch unique identifier. - GET1|Retrieve a Settlement
/api/v1/pa/financial/settlements/:idGet a specific settlement detail by specifying the Airwallex settlement unique identifier.
Issuing > Cards
- POST5|Activate a Card
/api/v1/issuing/cards/:id/activateActivate a physical card for card payment authorizations. - POST1|Create a Card
/api/v1/issuing/cards/createThe card object is the actual resource associated with the card issued out by Airwallex. It holds details such as linked account, embossed name (for physical… - GET3|List all Cards
/api/v1/issuing/cardsGet cards issued under an account. Will default to a 30 day period unless both *to* and *from* created_at request fields are populated. - GET7|List all Sensitive Card Details
/api/v1/issuing/cards/:id/detailsGet sensitive card information for virtual cards. This endpoint will only return data for active cards. - GET8|List all Card Remaining Limits
/api/v1/issuing/cards/:id/limitsRetrieve remaining limits of a card. - POST6|Provision a Card to a Digital Wallet
/api/v1/issuing/cards/:id/provision_digital_tokenProvisions a card into a digital wallet for in-app (push) provisioning. Available only to accounts with white-label digital wallets enabled. The request body… - GET2|Retrieve a Card
/api/v1/issuing/cards/:idRetrieve Card details. - POST4|Update a Card
/api/v1/issuing/cards/:id/updateUpdates card details by setting the values of the included parameters. Parameters that are not included will be left unchanged.
Issuing > Authorizations
- GET2|List all Authorizations
/api/v1/issuing/authorizationsDeprecated. Retrieves details of all card authorizations associated with your account. By default, authorizations created within the last 30 days are returned… - GET1|Retrieve an Authorization
/api/v1/issuing/authorizations/:idDeprecated. Retrieves details of an authorization performed on a card issued to your account. *This endpoint uses the legacy transaction model. Use…
Issuing > Card Transaction Events
- GET2|List all Card Transaction Events
/api/v1/issuing/card_transaction_eventsRetrieve a paginated list of transaction events. Each event includes its type, subtype, process result, and per-event amounts. Use the lifecycle_id or… - GET1|Retrieve a Card Transaction Event
/api/v1/issuing/card_transaction_events/:idRetrieve a single transaction event by its unique identifier. The response includes the event type, subtype, process result, failure reason (if declined), and…
Issuing > Card Transactions
- GET2|List all Card Transactions
/api/v1/issuing/card_transactionsRetrieve a paginated list of card transactions. Each card transaction includes its status, fund direction, merchant details, and aggregated billing amounts.… - GET1|Retrieve a Card Transaction
/api/v1/issuing/card_transactions/:idRetrieve a single card transaction by its unique identifier. The response includes the current status, fund direction, merchant details, and aggregated…
Issuing > Cardholders
- POST1|Create a Cardholder
/api/v1/issuing/cardholders/createCardholders are an authorized representative of your business. Two types of cardholder are permissible, Individual and Delegate. INDIVIDUAL: A cardholder who… - POST5|Delete a Cardholder
/api/v1/issuing/cardholders/:id/deleteDeletes the cardholder with the corresponding unique identifier. Deleting the cardholder will also cause all employee cards that are linked to the cardholder… - GET3|List all Cardholders
/api/v1/issuing/cardholdersGet all cardholders created within an account. - GET2|Retrieve the Cardholder Details
/api/v1/issuing/cardholders/:idRetrieve details for a cardholder. - POST4|Update a Cardholder
/api/v1/issuing/cardholders/:id/updateUpdate a cardholder with selected information. All fields are optional, and only those provided will be updated. If a composite object, e.g. name is provided,…
Issuing > Config
- GET1|Retrieve the Issuing Config
/api/v1/issuing/configRetrieves the default issuing settings configured for your account. - POST2|Update the Issuing Config
/api/v1/issuing/config/updateUpdate issuing config (currently only support remote call config update).
Issuing > Digital Wallet Tokens
- POST3|Update the Digital Wallet Token Status
/api/v1/issuing/digital_wallet_tokens/:id/lifecycleOnly available to platforms running their own white-labelled card program. Changes a digital wallet token's status - suspend, resume, delete, or activate via… - GET2|List all Digital Wallet Tokens
/api/v1/issuing/digital_wallet_tokensGet digital wallet tokens created under an account. Will default to a 30 day period unless both *to* and *from* created_at request fields are populated. - GET1|Retrieve a Digital Wallet Token
/api/v1/issuing/digital_wallet_tokens/:idRetrieves details of a digital wallet token for a given token ID.
Issuing > Card Transaction Lifecycles
- GET2|List all Card Transaction Lifecycles
/api/v1/issuing/lifecyclesRetrieve a paginated list of lifecycles. Each lifecycle provides a network-level view of a payment with aggregated billing amounts. Use the card_id filter to… - GET1|Retrieve a Card Transaction Lifecycle
/api/v1/issuing/lifecycles/:idRetrieve a single lifecycle by its unique identifier. The response includes aggregated billing amounts across all card transactions and transaction events in…
Issuing > Merchant Brands
- GET2|List all Merchant Brands
/api/v1/issuing/merchant_brandsRetrieve all Merchant Brands matching (by prefix) the name provided. If no name is provided, all Merchant Brands will be returned in alphabetical order. - GET1|Retrieve a Merchant Brand
/api/v1/issuing/merchant_brands/:idRetrieve a single merchant brand by its unique identifier.
Issuing > Transaction Disputes
- POST6|Cancel a Transaction Dispute
/api/v1/issuing/transaction_disputes/:id/cancelWhen a dispute status = SUBMITTED, the dispute can still be canceled via this API. Once the dispute status changes to IN_PROGRESS, the dispute is submitted to… - POST1|Create a Transaction Dispute
/api/v1/issuing/transaction_disputes/createCreates a dispute for a card transaction in a draft status. The dispute can be updated multiple times before submission to Airwallex for assessment. The… - GET3|List all Transaction Disputes
/api/v1/issuing/transaction_disputesRetrieve all transaction disputes. Filter for results using the parameters available. - GET2|Retrieve a Transaction Dispute
/api/v1/issuing/transaction_disputes/:idRetrieve single transaction dispute. - POST5|Submit a Transaction Dispute
/api/v1/issuing/transaction_disputes/:id/submitSubmit a dispute to Airwallex for review and processing. After a dispute has been submitted, its status will change to SUBMITTED. - POST4|Update a Transaction Dispute
/api/v1/issuing/transaction_disputes/:id/updateA dispute that has been created can be updated via this API. In the DRAFT status, all the fields in the dispute can be updated. Once a dispute is submitted,…
Issuing > Transactions
- GET2|List all Transactions
/api/v1/issuing/transactionsDeprecated. Retrieve all transactions associated with an account or for a specific card. Will default to a 30 day period unless both *to* and *from*… - GET1|Retrieve a Transaction
/api/v1/issuing/transactions/:idDeprecated. Retrieve single transaction. *This endpoint uses the legacy transaction model. Use Transaction Events, Card Transactions, and Lifecycles for the…
Payment Acceptance > Reference Data
- GET1|Retrieve the BIN Info
/api/v1/pa/reference/bin/lookupRetrieve the BIN info using the PAN passed via header param called x-pan.
Payment Acceptance > Payment Links
- POST6|Activate a Payment Link
/api/v1/pa/payment_links/:id/activateActivates an inactive payment link. - POST1|Create a Payment Link
/api/v1/pa/payment_links/createCreate a new payment link. - POST7|Deactivate a Payment Link
/api/v1/pa/payment_links/:id/deactivateDeactivates an active payment link. - GET3|List all Payment Links
/api/v1/pa/payment_linksRetrieves a list of payment links that a merchant has created previously. - POST5|Send a Payment Link
/api/v1/pa/payment_links/:id/notify_shopperSend an email notification to shopper with a payment link. - GET2|Retrieve a Payment Link
/api/v1/pa/payment_links/:idRetrieve information about an existing payment link. - POST4|Update a Payment Link
/api/v1/pa/payment_links/:id/updateUpdate attributes of an existing payment link.
Payment Acceptance > Config
- POST5|Add Apple Pay Domains
/api/v1/pa/config/applepay/registered_domains/add_itemsRegister one or more web domains to Apple Pay. - POST6|Remove Apple Pay Domains
/api/v1/pa/config/applepay/registered_domains/remove_itemsRemove one or more registered web domains from Apple Pay. - GET4|List all Apple Pay Domains
/api/v1/pa/config/applepay/registered_domainsGet all the web domains registered in Apple Pay. - GET3|List all Available Bank Names
/api/v1/pa/config/banks?payment_method_type=idealSome payment method types such as online_banking require the bank_name to be filled when confirming a Payment Intent. You may call this API to retrieve a list… - GET7|List all Convertible Shopper Currencies
/api/v1/pa/config/convertible_shopper_currenciesRetrieves a list of shopper currencies enabled for creating a conversion quote, which can be used as selectable options for payment currency conversion. - GET2|List all Available Payment Method Types
/api/v1/pa/config/payment_method_typesRetrieve configuration for available payment method types with different transaction modes. Note that the payment method types can be duplicate when it… - GET1|Retrieve the Current Reserve Plan
/api/v1/pa/config/reserve_planRetrieves reserve plan configuration details for your Airwallex account.
Payment Acceptance > Conversion Quotes
- POST1|Create a Conversion Quote
/api/v1/pa/conversion_quotes/createCreate a new conversion quote for converting from merchant currency to shopper currency. - GET2|Retrieve a Conversion Quote
/api/v1/pa/conversion_quotes/:idGet a conversion quote by specifying its unique id.
Payment Acceptance > Customers
- POST1|Create a Customer
/api/v1/pa/customers/createCreate a Customer object. We require the Customer unique identifier in the merchant's system as a mandatory field. - GET5|Generate a Client Secret for a Customer
/api/v1/pa/customers/:id/generate_client_secretGenerate a client secret for a Customer so that the client secret can be used as HTTP header client-secret from client-side to create a Payment Method or list… - GET3|List all Customers
/api/v1/pa/customersList all Customers. - GET2|Retrieve a Customer
/api/v1/pa/customers/:idRetrieve a Customer by unique identifier. This unique identifier is first returned when creating a new Customer. - POST4|Update a Customer
/api/v1/pa/customers/:id/updateUpdate customer's personal information. Use the Payment Methods API to update details of the attached Payment Methods.
Payment Acceptance > Customs Declarations
- POST1|Create a Customs Declaration
/api/v1/pa/customs_declarations/createStart the declaration process by creating a customs declaration. Please note that sub_order fields are required. If there is no need to split your original… - POST4|Redeclare a Customs Declaration
/api/v1/pa/customs_declarations/:id/redeclareRedeclare an existing customs declaration. SHANGHAI_CBT does not support redeclaration after a successful declaration. - GET2|Retrieve a Customs Declaration
/api/v1/pa/customs_declarations/:idRetrieve an existing customs declaration. - POST3|Update a Customs Declaration
/api/v1/pa/customs_declarations/:id/updateUpdate an existing customs declaration. SHANGHAI_CBT does not support update after a successful declaration.
Payment Acceptance > Funds Split Reversals
- POST1|Create a Funds Split Reversal
/api/v1/pa/funds_split_reversals/createInitiate a Funds Split Reversal to take money back from a connected account. You must specify a Funds Split as the source of reversal. When reversing a Funds… - GET3|List all Funds Split Reversals
/api/v1/pa/funds_split_reversals?funds_split_id=rev_hkpdkhwr5h1375nct0lList all Funds Split Reversals. - GET2|Retrieve a Funds Split Reversal
/api/v1/pa/funds_split_reversals/:idRetrieve a Funds Split Reversal by unique identifier.
Payment Acceptance > Funds Splits
- POST1|Create a Funds Split
/api/v1/pa/funds_splits/createStart dividing the funds you are collecting by creating a Funds Split. A Funds Split can be created only after the Payment Intent succeeds and before funds… - GET3|List all Funds Splits
/api/v1/pa/funds_splits?source_id=int_hkstskz7vg1xc7uscdj&source_type=stringList all Fund Splits. - POST4|Release a Funds Split
/api/v1/pa/funds_splits/:id/releaseCall this endpoint when you are ready to let the funds arrive at the destination. A Funds Split is capturable if auto_release=false. - GET2|Retrieve a Funds Split
/api/v1/pa/funds_splits/:idRetrieve a Funds Split by unique identifier.
Payment Acceptance > Payment Attempts
- GET2|List all Payment Attempts
/api/v1/pa/payment_attemptsList all Payment Attempts. Specify a value for payment_intent_id to list the Payment Attempts made on the Payment Intent. You may filter out the results… - GET1|Retrieve a Payment Attempt
/api/v1/pa/payment_attempts/:id
Payment Acceptance > Payment Consents
- POST1|Create a Payment Consent
/api/v1/pa/payment_consents/createCreate a Payment Consent. - POST7|Disable a Payment Consent
/api/v1/pa/payment_consents/:id/disableDisable a Payment Consent by unique identifier. After a Payment Consent is disabled, the status will become DISABLED and the Payment Consent cannot be used or… - GET3|List all Payment Consents
/api/v1/pa/payment_consentsList all Payment Consents. - GET2|Retrieve a Payment Consent
/api/v1/pa/payment_consents/:idRetrieve a Payment Consent by unique identifier. - POST4|Update a Payment Consent
/api/v1/pa/payment_consents/:id/updateUpdate the metadata of a Payment Consent. - POST5|Verify a Payment Consent
/api/v1/pa/payment_consents/:id/verifyVerify the Payment Consent with the payment_method details (or payment_method.id if reusing an existing one) when the customer is ready to store payment… - POST6|Continue To Verify a Payment Consent
/api/v1/pa/payment_consents/:id/verify_continueContinue verify a payment Consent, required when verification method is micro-deposit. Merchants can use this api to verify the amount of micro-deposit if the…
Payment Acceptance > Payment Disputes
- POST4|Accept a Payment Dispute
/api/v1/pa/payment_disputes/:id/acceptAccept a Payment Dispute. When a Payment Dispute is under status REQUIRES_RESPONSE, you can accept it to avoid further escalation and fees. Accepting the… - POST5|Challenge a Payment Dispute
/api/v1/pa/payment_disputes/:id/challengeChallenge a Payment Dispute. When you receive a Payment Dispute in Chargeback or RFI stage with REQUIRES_RESPONSE status then you can further challenge the… - GET2|List all Payment Disputes
/api/v1/pa/payment_disputesList all Payment Disputes using stage, status, reason code, due date, created time or updated time. - GET6|List all Related Payment Intents
/api/v1/pa/payment_disputes/:id/related_payment_intentsGet related payment intents for a Payment Dispute. Only applicable when the dispute reason type is FRAUDULENT or DUPLICATE_CHARGE. - GET1|Retrieve a Payment Dispute
/api/v1/pa/payment_disputes/:idRetrieve Payment Dispute information using Payment Dispute unique identifier. - POST3|Update a Payment Dispute
/api/v1/pa/payment_disputes/:id/updateUpdate a Payment Dispute by ID. Currently only the metadata field can be updated.
Payment Acceptance > Payment Intents
- POST9|Cancel a Payment Intent
/api/v1/pa/payment_intents/:id/cancelA Payment Intent can be cancelled when it is in one of these statuses: REQUIRES_PAYMENT_METHOD, REQUIRES_CUSTOMER_ACTION, REQUIRES_CAPTURE. Any outstanding,… - POST6|Capture a Payment Intent
/api/v1/pa/payment_intents/:id/captureCapture funds that have been confirmed but have not yet been captured or have only been captured partially. A Payment Intent is capturable if… - POST5|Confirm a Payment Intent
/api/v1/pa/payment_intents/:id/confirmCall this endpoint when your customer is ready to make a payment as per the details in the Payment Intent. At a minimum, a Payment Method must be set as the… - POST7|Continue To Confirm a Payment Intent
/api/v1/pa/payment_intents/:id/confirm_continueIn certain scenarios (i.e. 3DS and DCC), customer is required to provide additional information multiple times after the initial confirmation request. - POST1|Create a Payment Intent
/api/v1/pa/payment_intents/createStart collecting payment from your customer by creating a Payment Intent. The payment amount and currency, as well as the merchant order unique identifier… - POST8|Increment Authorization for a Payment Intent
/api/v1/pa/payment_intents/:id/increment_authorizationAllows you to authorize additional funds on an existing Payment Intent before capture. This is useful when the final payment amount is not known upfront, such… - GET3|List all Payment Intents
/api/v1/pa/payment_intentsList all Payment Intents. - GET2|Retrieve a Payment Intent
/api/v1/pa/payment_intents/:idRetrieve a Payment Intent by unique identifier. - POST4|Update a Payment Intent
/api/v1/pa/payment_intents/:id/updateUpdate properties on a Payment Intent. Some properties are only allowed to be updated in REQUIRES_PAYMENT_METHOD or REQUIRES_CUSTOMER_ACTION status. Depending…
Payment Acceptance > Payment Methods
- POST1|Create a Payment Method
/api/v1/pa/payment_methods/createCreate a Payment Method which can be referenced by Payment Consent. Alternatively you can directly provide entire payload of new Payment Method when verifying… - POST5|Disable a Payment Method
/api/v1/pa/payment_methods/:id/disableDisable Payment Method by unique identifier. The Payment Method status would become DISABLED. - GET3|List all Payment Methods
/api/v1/pa/payment_methodsList all Payment Methods. - GET2|Retrieve a Payment Method
/api/v1/pa/payment_methods/:idRetrieve Payment Method by unique identifier. - POST4|Update a Payment Method
/api/v1/pa/payment_methods/:id/updateDepending on the payment_method_type, you may update some of the details contained within.
Payment Acceptance > Terminals
- POST5|Activate a Terminal
/api/v1/pa/pos/terminals/:id/activateActivate a Terminal. - POST10|Cancel Current Operation on a Terminal
/api/v1/pa/pos/terminals/:id/cancel_current_operationCancel current operation on a Terminal if possible. - POST1|Create a Terminal
/api/v1/pa/pos/terminals/createCreate a new Terminal. The activation_code must be provided in the request body. The nickname is optional and can be used to identify the terminal. - POST8|Deactivate a Terminal
/api/v1/pa/pos/terminals/:id/deactivateDeactivate a Terminal. - GET3|List all Terminals
/api/v1/pa/pos/terminalsList all Terminals. - POST6|Process a Payment Intent in a Terminal
/api/v1/pa/pos/terminals/:id/process_payment_intentProcess a Payment Intent In a Terminal. - POST7|Reset a Terminal Password
/api/v1/pa/pos/terminals/:id/reset_passwordReset a Terminal password. - GET2|Retrieve a Terminal
/api/v1/pa/pos/terminals/:idRetrieve a Terminal by unique identifier. - POST9|Terminate a Terminal
/api/v1/pa/pos/terminals/:id/terminateTerminate a Terminal. - POST4|Update a Terminal
/api/v1/pa/pos/terminals/:id/updateUpdate a Terminal.
Payment Acceptance > Refunds
- POST1|Create a Refund
/api/v1/pa/refunds/createCreate a Refund against a Payment Intent/Payment Attempt. - GET3|List all Refunds
/api/v1/pa/refundsList all Refunds. - GET2|Retrieve a Refund
/api/v1/pa/refunds/:idRetrieve a Refund by unique identifier.
Payment Acceptance > Settlement Records
- GET1|List all Settlement Records
/api/v1/pa/settlement_recordsGet Settlement Records by specifying the settlement (batch) unique identifier or payment intent unique identifier.
Payment Acceptance > Customer Balance Transactions
- GET1|Retrieve a Customer Balance Transaction
/api/v1/pa/customer_balance_transactions/:idRetrieve a Customer Balance Transaction by unique ID.
Payouts > Batch Transfers
- POST4|Add Items To a Batch
/api/v1/batch_transfers/:id/add_itemsAdd transfer items to a batch by specifying the batch transfer id. You may add 100 items at a time and add up to a maximum of 1000 items per batch transfer.… - POST1|Create a Batch Transfer
/api/v1/batch_transfers/createCreate a new batch transfer. - POST7|Delete a Batch Transfer
/api/v1/batch_transfers/:id/deleteBefore submitting a batch transfer, you can delete a batch by specifying the batch transfer id. Please note that you can only delete a batch transfer when its… - POST8|Delete Items Within a Batch
/api/v1/batch_transfers/:id/delete_itemsBefore submitting a batch transfer, you can delete invalid or wrong items in the batch by specifying the batch transfer id and item_ids. Please note that you… - GET3|List all Batch Transfers
/api/v1/batch_transfersRetrieve batch transfers with optional filters on request id, status, or pagination parameters (page, page_size). - GET9|List all Items Within a Batch
/api/v1/batch_transfers/:id/itemsRetrieve all items added to the batch transfer by specifying the batch transfer id. - POST5|Quote a Batch Transfer
/api/v1/batch_transfers/:id/quoteAfter adding valid transfer items to the batch, you can quote/lock FX rates by specifying the batch transfer id. Please note that only valid items in the… - GET2|Retrieve a Batch Transfer
/api/v1/batch_transfers/:idRetrieve details of a batch transfer by specifying the batch transfer id. - POST6|Submit a Batch Transfer
/api/v1/batch_transfers/:id/submitSubmit a batch transfer by specifying the batch transfer id. Please note that only valid items in the batch will be submitted. If no approval is required,…
Payouts > Beneficiaries
- POST1|Create a Beneficiary
/api/v1/beneficiaries/create> [!INFORMATIONAL: Transfer to card is available for early access] > Expect limited functionality as we continue development and build the product in… - POST7|Delete an Existing Beneficiary
/api/v1/beneficiaries/:id/deleteDelete an existing beneficiary stored on the Airwallex platform. - POST8|Retrieve the API Schema
/api/v1/beneficiary_api_schemas/generate> [!INFORMATIONAL: Transfer to card is available for early access] > Expect limited functionality as we continue development and build the product in… - POST9|Retrieve the Form Schema
/api/v1/beneficiary_form_schemas/generate> [!INFORMATIONAL: Transfer to card is available for early access] > Expect limited functionality as we continue development and build the product in… - GET3|List all Beneficiaries
/api/v1/beneficiariesGet list of beneficiaries with optional filters on from date/time, to date/time, names and entity type. Results are paginated, with default list limit of 50… - GET11|List all Supported Financial Institutions
/api/v1/beneficiary_form_schemas/supported_financial_institutions?account_currency=string&bank_country_code=string&entity_type=string&transfer_method=stringRetrieve an array of Airwallex’s supported financial institutions for beneficiaries, which can be used to build your own interface. Specify the beneficiaries'… - GET2|Retrieve a Beneficiary
/api/v1/beneficiaries/:idGet a specific beneficiary by specifying the Airwallex id. - POST4|Update an Existing Beneficiary
/api/v1/beneficiaries/:id/updateEdit an existing beneficiary stored on the Airwallex platform. - POST5|Validate a Beneficiary
/api/v1/beneficiaries/validateGiven a beneficiary request, validate it and return all failed fields as a 400 response. No errors will be "OK" as a 200 response. - POST6|Verify a Beneficiary Account
/api/v1/beneficiaries/verify_accountSubmit beneficiary account details to verify its existance and retreive name-matching result (where supported) across supported regions and transfer methods…
Payouts > Payers
- POST1|Create a Payer
/api/v1/payers/createCreate a new payer to be stored on the Airwallex platform. - POST6|Delete an Existing Payer
/api/v1/payers/:id/deleteDelete an existing payer stored on the Airwallex platform. - GET3|List all Payers
/api/v1/payersGet list of payers with optional filters on from date/time, to date/time, names and entity type. Results are paginated, with default list limit of 50 results. - GET2|Retrieve a Payer
/api/v1/payers/:idGet a specific payer by specifying the Airwallex payer_id. - POST7|Retrieve the Payer Schema
/api/v1/payers/schemaGiven a partial payer request, return a dynamic schema of all fields. Can be used to generate a dynamic payer form user interface. [beta]: This is a new… - POST4|Update an Existing Payer
/api/v1/payers/:id/updateEdit an existing payer stored on the Airwallex platform. - POST5|Validate a Payer
/api/v1/payers/validateGiven a payer request, validate it and return all failed fields as a 400 response. No errors will be OK as a 200 response.
Payouts > Transfers
- POST6|Cancel a Transfer
/api/v1/transfers/:id/cancelCancel a transfer by specifying the id. - POST4|Confirm Funding for a Transfer
/api/v1/transfers/:id/confirm_fundingConfirm funding of a transfer under the post-funding settlement model by specifying the id. The funding status of this transfer will transition from… - POST1|Create a Transfer
/api/v1/transfers/create> [!INFORMATIONAL: Transfer to card is available for early access] > Expect limited functionality as we continue development and build the product in… - GET3|List all Transfers
/api/v1/transfersGet list of transfers from a specified creation date/time, with optional filters on end creation date/time, buy/sell currency and status. Alternatively, one… - GET2|Retrieve a Transfer
/api/v1/transfers/:idGet a specific transfer by specifying the Airwallex id. - POST5|Validate a Transfer
/api/v1/transfers/validateGiven a transfer request, validate it and return all failed fields as a 400 response. No errors will be "OK" as a 200 response.
Risk > Fraud Feedback (Issuing)
- POST1|Fraud Feedback (Issuing)
/api/v1/risk/issuing/fraud_feedbackCreate a confirmation on whether a transaction was authorized by the cardholder.
Risk > Watchlist
- POST4|Add an Item to the Watchlist
/api/v1/risk/watchlist/createAdd an item to the Watchlist. - GET2|List all Items
/api/v1/risk/watchlistGet list of items with optional filters, sorted by the item creation date in descending order. - GET1|Retrieve an Item
/api/v1/risk/watchlist/:item_idGet a specific Watchlist item by specifying the Airwallex item_id. - POST3|Update an Item
/api/v1/risk/watchlist/:item_id/updateEdit an existing Watchlist item stored on the Airwallex platform.
Risk > Request for Information (RFI)
- GET2|List all RFIs
/api/v1/rfisReturns a list of RFIs raised for your Airwallex account, sorted by the RFI creation date in descending order. - POST3|Respond to an RFI
/api/v1/rfis/:id/respondAllows you to respond to an RFI request by providing the required answers. - GET1|Retrieve an RFI
/api/v1/rfis/:idRetrieves details of an RFI using the given RFI unique identifier.
Risk > Sellers
- POST1|Create a Seller
/api/v1/sellers/createCreates a new seller for your MoR account. - POST3|Deactivate a Seller
/api/v1/sellers/:id/deactivateDeactivates an existing seller by unique identifier. - GET2|Retrieve a Seller
/api/v1/sellers/:idRetrieves details of a seller using the given seller unique identifier.
Embedded Finance > Platform Reports
- POST1|Create a Platform Report
/api/v1/platform_reports/createCreate a new report. This request triggers an Airwallex job to generate a new report. A report id is returned that can then be used to retrieve the download… - GET2|Retrieve a Platform Report
/api/v1/platform_reports/:idRetrieve the download URL of a report once the report is ready. Subscribe to the Platform Report webhook in the Airwallex webapp to be notified when the…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.airwallex.comhttps://api.sandbox.airwallex.com- Authentication
- A bearer token in the Authorization header
- Operations
- 429 operations on 428 pathsPOST 237GET 192
4 marked deprecated - Main resources
- Billing > Invoices 17Core Resources > Global Accounts 17Billing > Credit Notes 13Core Resources > Linked Accounts 12Embedded Finance > Accounts 12Payment Acceptance > Terminals 10Payouts > Beneficiaries 10Payment Acceptance > Payment Intents 9Payouts > Batch Transfers 9Embedded Finance > Platform Liquidity Programs 8
- Response formats
application/jsonapplication/pdfapplication/octet-streamapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet- Webhooks
- 308 described
- Description format
- OpenAPI 3.1.0, API version
2026-08-21 - Links
- OpenAPI document · Terms of service
How to test the Airwallex API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Airwallex API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “3|Enable an Account Capability” (POST /api/v1/account_capabilities/:id/enable), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Airwallex API?
Airwallex Client Api Documentation. It is listed under Payments and has 429 endpoints.
Who publishes the Airwallex API?
It is listed from Airwallex's public API description (an OpenAPI document), not published by Airwallex on Swastik Codes. Anyone who controls airwallex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Airwallex API?
Its description lists 2 base URLs: https://api.airwallex.com, https://api.sandbox.airwallex.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Airwallex API?
With A bearer token in the Authorization header.
How many endpoints does the Airwallex API have?
429 operations on 428 paths (237 POST, 192 GET). The largest groups are Billing > Invoices, Core Resources > Global Accounts, Billing > Credit Notes, Core Resources > Linked Accounts. This listing's collection holds the first 400.
Is forking the Airwallex API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.