# Airwallex integration

> Global business accounts, payments acceptance, payouts, FX, cards and spend, and billing via the Airwallex API

- Authentication: apiKey

## Tools (407)

- **Accept a Mandate**: Accept a Mandate by transitioning the mandate status from `PROCESSING` to `ACTIVE`.
- **Accept a Payment Dispute**: Accept a Payment Dispute. When a Payment Dispute is under status `REQUIRES_RESPONSE`, you can accept it to avoid further escalation and fees. Accepting the dispute during `RFI` stage will trigger a full refund. The refund amount and reason can be customized by populating the `refund` field.
- **Activate a Card**: Activate a physical card for card payment authorizations.
- **Activate a Payment Link**: Activates an inactive payment link.
- **Activate a Terminal**: Activate a Terminal.
- **Add an Item to the Watchlist**: Add an item to the Watchlist.
- **Add Apple Pay Domains**: Register one or more web domains to Apple Pay.
- **Adjust Program Spending Account Limits**: > Status: beta
- **Agree To Terms and Conditions**: Account agrees to terms and conditions.
- **Approve an Account Amendment**: Use this endpoint to approve an account amendment in PENDING status. Please note that the action is asynchronous and may take some time to complete. This endpoint does not guarantee an immediate status change upon request.
- **Archive a Meter**: Archive 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.
- **Authorize a Flow**: Explicitly authorize the user to access a created hosted flow instance. You can then redirect the user to the `url` link in the response.
- **Authorize an Account**: Authorize the platform itself, or a connected account with header `x-on-behalf-of` to use embedded components.
- **Batch Ingest Usage Events**: Ingest new usage events in a batch. The events are validated and processed asynchronously. If errors occur, webhook events will be published. Maximum 10 events per request.
- **Cancel a Billing Checkout**: A 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 message when attempting to load it.
- **Cancel a Checkout Session**: > Status: early_access
- **Cancel a Direct Debit**: Cancel a direct debit by transaction id.
- **Cancel a Direct Debit Payout Mandate**: Cancel a Direct Debit Payout Mandate by an Airwallex global account id and mandate id.
- **Cancel a Mandate**: Cancel a Mandate by transitioning the mandate status from `PROCESSING` or `ACTIVE` to `INACTIVE`.
- **Cancel an Alias for a Global Account**: Cancels an alias for a Global Account. Once cancelled, the alias can no longer be used for any transactions, such as receiving funds.
- **Cancel an Offboarding**: Use this endpoint to simulate cancelling the offboarding of a connected account.
- **Cancel a Payment Intent**: A Payment Intent can be cancelled when it is in one of these statuses: `REQUIRES_PAYMENT_METHOD`, `REQUIRES_CUSTOMER_ACTION`, `REQUIRES_CAPTURE`.
- **Cancel a PSP Settlement Intent**: Use this endpoint to cancel a PSP Settlement intent.
- **Cancel a PSP Settlement Split**: If the PSP settlement split has not yet been matched, it can be cancelled (for example, if data had been shared wrongly previously.) After cancelling, the associated PSP settlement intent status becomes `NEW`. A new PSP settlement split should be created after cancellation to ensure all funds in the
- **Cancel a Subscription**: Cancels a Subscription immediately and refunds based on specified proration behavior.
- **Cancel a Transaction Dispute**: When 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 the card scheme by Airwallex and cannot be canceled. Relevant dispute fees may apply once the dispute status = IN_PROGRESS.
- **Cancel a Transfer**: Cancel a transfer by specifying the `id`.
- **Cancel Current Operation on a Terminal**: Cancel current operation on a Terminal if possible.
- **Capture a Payment Intent**: Capture funds that have been confirmed but have not yet been captured or have only been captured partially. A Payment Intent is capturable if `auto_capture=false` and its `next_action` indicates that capture is required.
- **Capture the Card Transaction Lifecycle**: Capture a card transaction lifecycle using the given lifecycle ID. This is only available in the sandbox environment.
- **Challenge a Payment Dispute**: Challenge a Payment Dispute. When you receive a Payment Dispute in Chargeback or RFI stage with `REQUIRES_RESPONSE` status then you can further challenge the Payment Dispute. Challenge response should include at least one of the recommended evidence document types attached, please use [File Service]
- **Check Available Balances**: Retrieves the balance of a Linked Account using the given Linked Account unique identifier. This API is only available to Linked Accounts where `capabilities.balance_check` is true. The request will be routed to the respective financial institutions, so you may experience a slight delay in the respo
- **Close a Global Account**: Close a global account created under your Airwallex account.
- **Close an RFI**: Use this endpoint to close an RFI.
- **Complete an Offboarding**: Use this endpoint to simulate completing the offboarding of a connected account.
- **Complete the Authentication Refresh**: Completes the authentication refresh. After the refresh authentication process is confirmed, the corresponding Linked Account status will become `SUCCEEDED`.
- **Confirm a Linked Account Among Candidate Accounts**: Confirm your Linked Account among a list of candidate accounts that have already been verified.
- **Confirm a Payment Intent**: Call this endpoint when your customer is ready to make a payment as per the details in the Payment Intent.
- **Confirm Funding for a Transfer**: Confirm funding of a transfer under the post-funding settlement model by specifying the `id`. The funding status of this transfer will transition from `REQUIRES_FUNDING_CONFIRMATION` to `SCHEDULED` accordingly.
- **Confirm Payment Using a Scenario**: Confirm the current terminal's linked payment using a specific scenario.
- **Continue To Confirm a Payment Intent**: In certain scenarios (i.e. 3DS and DCC), customer is required to provide additional information multiple times after the initial confirmation request.
- **Continue To Verify a Payment Consent**: Continue 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 consent wait for the verification result of micro-deposit. Micro-debit is triggered when micro-deposit is triggered, micro-debit is n
- **Create a Beneficiary**: Create a new beneficiary to be stored on the Airwallex platform.
- **Create a Billing Checkout**: Creates a Billing Checkout object.
- **Create a Billing Customer**: Creates a Billing Customer.
- **Create a Card**: The 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 cards), shipping method and information (for physical cards), card based spend controls (eg. transaction limits, blocked merchant category cod
- **Create a Cardholder**: Cardholders are an authorized representative of your business. Two types of cardholder are permissible, Individual and Delegate. `INDIVIDUAL`: A cardholder who is associated with a named individual that is a representative of your business. Can be associated with a personalized or non-personalized c
- **Create a Charge**: Create a charge to be applied to a connected account.
- **Create a Checkout Session**: > Status: early_access
- **Create a Confirmation Letter**: Given a transaction id , to generate confirmation letter , return as file stream, currently support deposit and payment.
- **Create a Connected Account Transfer**: Initiate a new connected account transfer to send funds from your Airwallex account to a connected account. Your Airwallex balance must cover the transfer amount or you will receive an “Insufficient Funds” error message.
- **Create a Conversion**: Create a new conversion to be executed within your Airwallex wallet. To associate a conversion with a payout, use the Payment API. (Note: Some [exotic currencies](https://www.airwallex.com/docs/transactional-fx/supported-regions-and-currencies.md) require conversions to be associated with payouts.)
- **Create a Conversion Quote**: Create a new conversion quote for converting from merchant currency to shopper currency.
- **Create a Coupon**: Creates a new coupon template that can be redeemed in purchases.
- **Create a Credit Note**: Create a Credit Note that is linked to an Invoice.
- **Create a Customer**: Create a **Customer** object. We require the Customer unique identifier in the merchant's system as a mandatory field.
- **Create a Customs Declaration**: Start 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 order, please fill the sub_order fields with your original order information for declaration. In this case, remember to use the provider_order_i
- **Create a Deposit Via Direct Debit**: Deposits funds into your Airwallex account via Direct Debit from a [Linked Account](https://www.airwallex.com/docs/api/core_resources/linked_accounts.md).
- **Create a Financial Report**: Create a balance activity, transaction reconciliation, or settlement report.
- **Create a Flow**: Create a hosted flow instance for an account. Specify the `account_id` of the connected account for which you are creating the flow, and the hosted flow `template` provided by Airwallex.
- **Create a Funds Split**: Start dividing the funds you are collecting by creating a Funds Split.
- **Create a Funds Split Reversal**: Initiate a Funds Split Reversal to take money back from a connected account. You must specify a Funds Split as the source of reversal.
- **Create a General Ledger Account**: > Status: beta
- **Create a Global Account**: Submit 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 via the local clearing system or swift system.
- **Create a Global Account Deposit**: You can use this endpoint to simulate deposits into your global account. This is only available in the sandbox environment.
- **Create a Linked Account**: Links 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 `linked_accounts/auth` endpoint to generate an authentication token.
- **Create a Meter**: Create a new Meter object.
- **Create an Account**: Create a new Airwallex account for your users, merchants, subsidiaries, business partners or clients. You can append more information to the account after creation using the ‘update account’ endpoint. To append documents, please use the ‘file service’ endpoint. Once all the required information has
- **Create an Account Amendment**: Creates an amendment request to edit existing account data for an account that has passed KYC verification.
- **Create an Accounting Field**: > Status: beta
- **Create an Accounting Field Value**: > Status: beta
- **Create an Account Invitation Link**: 
- **Create an Alias for a Global Account**: Creates an alias for a Global Account to receive funds. Supported alias types include: `EMAIL`, `PHONE_NUMBER`, and `AUSTRALIAN_BUSINESS_NUMBER`. For alias types `EMAIL` or `PHONE_NUMBER`, a verification code will be sent via email or SMS respectively. You must submit this code for verification usin
- **Create an Amendment**: Create an amendment on a booked but unsettled conversion.
- **Create an Amendment Quote**: Create an amendment quote on a booked but unsettled conversion. Get an indicative quote for the charge fee.
- **Create an Invoice**: Creates a one-off Invoice.
- **Create an Offboarding**: Submit an offboarding request for a connected account. This creates an Airwallex Operations-owned offboarding case; it does not replace operations handling of the closure workflow.
- **Create an RFI**: Use this endpoint to create an RFI for specific type. The questions and related sources are simulated. All RFIs for specified type must be in `CLOSED` status.
- **Create a Payment Consent**: Create a Payment Consent.
- **Create a Payment Dispute**: By creating a dispute, we raise a dispute for the merchant to respond.
- **Create a Payment Intent**: Start collecting payment from your customer by creating a Payment Intent. The payment `amount` and `currency`, as well as the merchant order unique identifier must be provided.
- **Create a Payment Link**: Create a new payment link.
- **Create a Payment Method**: Create a Payment Method which can be referenced by Payment Consent.
- **Create a Payment Source**: Creates a **PaymentSource** using a linked payment method from a supported **Payment Service Provider (PSP)**. When **Airwallex Payments** is used as the PSP, you can create a **PaymentSource** with a **PaymentMethod** authorized for **merchant-initiated payments**. This authorization can be obtaine
- **Create a Platform Report**: > Status: beta
- **Create a Price**: Create a new Price object.
- **Create a Product**: Creates a new Product object.
- **Create a Program Spending Account**: > Status: beta
- **Create a PSP Settlement Intent**: Use this endpoint to share data with Airwallex on the *settlement* to be deposited by the PSP.
- **Create a Quote**: The Quote endpoint gives the user a guaranteed rate for an agreed period of time.
- **Create a Rate Card**: Create a new Rate Card with shared billing fields, dimension keys, and a list of items. Each item entry creates a Rate Card Item object.
- **Create a Rate Card Version**: Publish a new Rate Card version. `items` is the complete ordered list; each entry is either the `id` of an existing Rate Card Item (carried forward by reference) or an inline definition of a new item.
- **Create a Refund**: Create a Refund against a Payment Intent/Payment Attempt.
- **Create a Seller**: Creates a new seller for your MoR account.
- **Create a Subscription**: Create a new Subscription for an existing Billing Customer to charge the customer on a recurring basis.
- **Create a Tax Code**: > Status: beta
- **Create a Terminal**: Create 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.
- **Create a Transaction Dispute**: Creates a dispute for a card transaction in a draft status. The dispute can be updated multiple times before submission to Airwallex for assessment. The transaction dispute object is the resource of a card transaction dispute raised to Airwallex.It contains all the information related to a dispute s
- **Create a Transaction for the Provided Card**: Creates a transaction for the card_id (or card_number) provided, but does not capture the transaction. This is only available in the sandbox environment.
- **Create a Transfer**: Create a new transfer to a beneficiary. The transfer can either include an underlying conversion when the transfer currency varies from the source currency, or will not include a conversion when the transfer currency and source currency match.
- **Create a Webhook**: Creates a new Webhook and subscribes to a list of webhook events from Airwallex.
- **Create Credit Note Line Items and Add Them to a Credit Note**: Create 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 bulk create operation is atomic, all the line items created with the request will either succeed or fail together.
- **Create Invoice Line Items and Add Them to an Invoice**: This is only possible when the status of an [Invoice](https://www.airwallex.com/docs/api/billing/invoices.md) is in `DRAFT`. You can add up to 100 line items at a time. This bulk operation is atomic.
- **Deactivate a Payment Link**: Deactivates an active payment link.
- **Deactivate a Seller**: Deactivates an existing seller by unique identifier.
- **Deactivate a Terminal**: Deactivate a Terminal.
- **Delete a Cardholder**: Deletes the cardholder with the corresponding unique identifier. Deleting the cardholder will also cause all employee cards that are linked to the cardholder to also be closed.
- **Delete a Credit Note**: Delete a draft Credit Note.
- **Delete a Draft Invoice**: Delete a draft Invoice.
- **Delete an Existing Beneficiary**: Delete an existing beneficiary stored on the Airwallex platform.
- **Delete a Webhook**: Deletes a Webhook. A deleted webhook will no longer receive webhook events of any Airwallex organisations or accounts.
- **Delete Credit Note Line Items From a Credit Note**: Delete 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 operation is atomic, all the removals in the request will either succeed or fail together.
- **Delete Invoice Line Items Within an Invoice**: This is only possible when the status of an [Invoice](https://www.airwallex.com/docs/api/billing/invoices.md) is in `DRAFT`. You can delete up to 100 line items at a time. This bulk operation is atomic.
- **Deposit Funds Into a Program**: > Status: beta
- **Disable a Payment Consent**: Disable 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 updated.
- **Disable a Payment Method**: Disable Payment Method by unique identifier. The Payment Method status would become `DISABLED`.
- **Enable an Account Capability**: Submit a request to enable a specific capability for your Airwallex account.
- **Escalate a Payment Dispute**: By escalating a dispute, the evidence provided by the merchant is declined, and the dispute is escalated to the next stage.
- **Fail a Micro Deposits Verification**: Fail a Micro Deposits verification by transitioning the Linked Account status from `REQUIRES_ACTION` to `FAILED` with the reason `MICRO_DEPOSIT_FAILED`.
- **Fail Next Autocharge**: Use this endpoint to simulate the failure of the next auto charge execution of a payment source. This will cause the next scheduled auto-charge to fail, allowing you to test error handling and retry logic in your billing workflows. This is only available in the Sandbox environment.
- **Finalize a Credit Note**: Finalize 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 need to allocate the `total_amount` of the credit note to either `refund_amount` or `out_of_band_amount`.
- **Finalize an Invoice**: Finalizes a draft invoice.
- **Follow-up RFI**: Use this endpoint to create a follow-up on an existing RFI. You can choose to retain the existing questions, append new ones, or both, depending on your testing needs.
- **Fraud Feedback (Issuing)**: Create a confirmation on whether a transaction was authorized by the cardholder.
- **Generate a Client Secret for a Customer**: Generate 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](https://www.airwallex.com/docs/api/payments/payment_methods/create.md) or [list Payment Method](https://www.airwallex.com/docs/api/payments/payme
- **Generate a Linked Account Authentication**: Generates a Linked Account authentication. You will retrieve an authentication token with the specified Open Banking provider to verify the ownership of the external bank account, so that the external bank account owner may verify their access to the account.
- **Generate an Activation Code**: Generates an activation code for the terminal owner to enter in the Airwallex web app to activate the terminal device.
- **Generate a risk report**: Submits a risk report query for the authenticated merchant. Returns immediately with an `id`; the report is generated asynchronously. Poll the **Retrieve a risk report** endpoint (`GET /api/v1/risk/risk_reports/{id}`) using the returned `id` to track progress. When the report reaches `COMPLETED` sta
- **Generate Global Account Statement**: Generate global account statement letter, return as file stream.
- **Get list of Checkout Sessions**: > Status: early_access
- **Get list of E-Invoicing Documents**: > Status: early_access
- **Increase Transfer or Deposit Limit**: Increase your transfer or deposit limit by providing cross-border sales order information. Before uploading, please learn about [payout limits](https://www.airwallex.com/docs/payouts/transfers/transfers-to-from-countries-with-regulatory-requirements.md) or [deposit limits](https://www.airwallex.com/
- **Increment Authorization for a Payment Intent**: Allows 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 as in hotel or car rental scenarios. Only a single capture and clearing occurs for the final authorized amount.
- **Industry Categories**: Get a tree of industry categories and associated codes and questions.
- **Ingest a Usage Event**: Ingest a single usage event. The event is validated synchronously, but is processed asynchronously. For higher rate limits, please use the [Batch Ingest Usage Events API](https://www.airwallex.com/docs/api/billing/usage_events/batch_ingest.md) instead.
- **Initiate an Alias Port for a Global Account**: Initiates an alias port to transfer the alias details to a different Airwallex Global Account or to another external bank account. After you submit the request, the alias status changes to PORT_INITIATED and then requires further action to complete the port once the alias becomes portable. To comple
- **Invalid Conversion Dates**: Gets a list of invalid conversion dates for a specified `currency_pair`.
- **List all Accounting Fields**: > Status: beta
- **List all Accounting Field Values**: > Status: beta
- **List all Aliases**: Retrieves a list of aliases registered to a given Global Account.
- **List all Amendments**: Retrieve all amendments associated with a conversion unique identifier. (Right now, since only full cancellations are supported, a conversion will only have up to 1 associated amendment.).
- **List all Apple Pay Domains**: Get all the web domains registered in Apple Pay.
- **List all Authorizations**: > Status: deprecated
- **List all Available Bank Names**: Some 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 of available banks and let the shopper choose one before confirming a Payment Intent. Refer to [confirm](https://www.airwallex.com/docs/a
- **List all Available Payment Method Types**: Retrieve configuration for available payment method types with different transaction modes.
- **List all Available Payment Scenarios**: Retrieves all payment scenarios supported by the sandbox environment for in-person payment flows.
- **List all Beneficiaries**: Get 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 results.
- **List all Billing Checkouts**: Retrieves a list of Billing Checkouts based on the query parameters.
- **List all Billing Customers**: Retrieves a list of Billing Customers based on the query parameters.
- **List all Billing Transactions**: Retrieves a list of Billing Transactions based on the query parameters.
- **List all Cardholders**: Get all cardholders created within an account.
- **List all Card Remaining Limits**: Retrieve remaining limits of a card.
- **List all Cards**: Get cards issued under an account. Will default to a 30 day period unless both *to* and *from* created_at request fields are populated.
- **List all Card Transaction Events**: Retrieve a paginated list of transaction events. Each event includes its type, subtype, process result, and per-event amounts. Use the `lifecycle_id` or `card_transaction_id` filter to trace the sequence of events within a specific lifecycle or card transaction.
- **List all Card Transaction Lifecycles**: Retrieve 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 narrow results to a specific card.
- **List all Card Transactions**: Retrieve a paginated list of card transactions. Each card transaction includes its status, fund direction, merchant details, and aggregated billing amounts. Use the `lifecycle_id` filter to retrieve all card transactions within a specific lifecycle, or `status` to filter by transaction status.
- **List all Charges**: Get a list of charges created by your Airwallex account. The charges returned will be sorted by creation time.
- **List all Connected Accounts**: Get list of accounts connected to your platform. If you’re not a platform, the list is empty.
- **List all Connected Account Transfers**: Get a list of connected account transfers created by your Airwallex account. The transfers returned are sorted by creation time.
- **List all Connected Stores**: Get a list of connected stores based on the query parameters.
- **List all Conversions**: Retrieve conversions, using any combination of optional queryable parameters below. You may specify none, one of, or both `from_created_at` or `to_created_at` parameters. If none of these parameters are specified, results for the last 31 days will be returned. If only one of these parameters are spe
- **List all Convertible Shopper Currencies**: Retrieves a list of shopper currencies enabled for creating a conversion quote, which can be used as selectable options for payment currency conversion.
- **List all Coupons**: Get a list of coupons.
- **List all Credit Note Line Items**: Retrieves a list of Credit Note Line Items based on the query parameters.
- **List all Credit Notes**: Retrieve a list of Credit Notes based on the query parameters.
- **List all Current Balances**: Get *available* and *pending* balances for every currency.
- **List all Customers**: List all Customers.
- **List all Deposits**: Returns 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 specified, then deposits 30 days in arrears of today or the end date will be returned.
- **List all Digital Wallet Tokens**: Get 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.
- **List all Direct Debit Payout Mandates**: Get a list of Direct Debit Payout Mandates by an Airwallex global account id.
- **List all Direct Debits**: Get 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 within 30 days of today will be returned. If only to_created_date is provided, direct debits within 30 days of to_created_date will be returne
- **List all File Download Links**: Populate the download request with a list of file unique identifiers and the API responds with associated download links. Links will be valid for 1 day. Files do not exceed 20MB. Can also be used by Scale platforms to download files for connected accounts using the x-on-behalf-of header.
- **List all Financial Reports**: Get list of previously generated balance activity, transaction reconciliation, settlement, account statement, and aggregated settlement reports.
- **List all Financial Transactions**: Get a list of financial transactions that contributed to the Airwallex account balance from a specified creation date/time, with optional filters on end creation date/time, batch_id and status.
- **List all Funding Limits**: Before 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.
- **List all Funds Split Reversals**: List all Funds Split Reversals.
- **List all Funds Splits**: List all Fund Splits.
- **List all General Ledger Accounts**: > Status: beta
- **List all Global Accounts**: Get list of global accounts created by your Airwallex account.
- **List all Global Account Transactions**: Obtain transaction details of funds received into your specified global account.
- **List all Invoice Line Item Groups**: Retrieves a list of line item groups for an [Invoice](https://www.airwallex.com/docs/api/billing/invoices.md).
- **List all Invoice Line Items**: Retrieves a list of Invoice Line Items based on the query parameters.
- **List all Invoices**: Retrieves a list of Invoices based on the query parameters.
- **List all Items**: Get list of items with optional filters, sorted by the item creation date in descending order.
- **List all Linked Accounts**: Returns a list of Linked Accounts associated with a specific Airwallex account.
- **List all Merchant Brands**: Retrieve all Merchant Brands matching (by prefix) the name provided. If no name is provided, all Merchant Brands will be returned in alphabetical order.
- **List all Meters**: Retrieves a list of Meters based on the query parameters.
- **List all Offboardings**: Retrieve a paginated list of offboardings for a connected account.
- **List all Payment Attempts**: List 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 further by `method` and/or `status`.
- **List all Payment Consents**: List all Payment Consents.
- **List all Payment Disputes**: List all Payment Disputes using stage, status, reason code, due date, created time or updated time.
- **List all Payment Intents**: List all Payment Intents.
- **List all Payment Links**: Retrieves a list of payment links that a merchant has created previously.
- **List all Payment Methods**: List all Payment Methods.
- **List all Payment Sources**: Retrieves a list of Payment Sources based on the query parameters.
- **List all Prices**: Retrieves a list of Prices based on the query parameters.
- **List all Products**: Retrieves a list of Products based on the query parameters.
- **List all Program Spending Accounts**: > Status: beta
- **List all Program Transactions**: > Status: beta
- **List all PSP Settlement Deposits**: Get a list of PSP settlement deposits sent to your account. The deposits returned are sorted by deposit time in descending order.
- **List all PSP Settlement Intents**: Get a list of PSP settlement intents created by your account. The intents returned are sorted by creation time in descending order.
- **List all PSP Settlement Splits**: Get list of PSP settlement splits created by your account. The splits returned are sorted by creation time in descending order.
- **List all Rate Card Items**: Retrieves the Rate Card Items belonging to a specific version of a Rate Card. Items are returned in rank order, which determines first-match evaluation.
- **List all Rate Cards**: Retrieves a list of Rate Cards, based on the query parameters.
- **List all Rate Card Versions**: Retrieves the list of a Rate Card's versions.
- **List all Refunds**: List all Refunds.
- **List all Related Payment Intents**: Get related payment intents for a Payment Dispute. Only applicable when the dispute reason type is `FRAUDULENT` or `DUPLICATE_CHARGE`.
- **List all RFIs**: Returns a list of RFIs raised for your Airwallex account, sorted by the RFI creation date in descending order.
- **List all Sensitive Card Details**: Get sensitive card information for virtual cards. This endpoint will only return data for active cards.
- **List all Settlement Records**: Get Settlement Records by specifying the settlement (batch) unique identifier or payment intent unique identifier.
- **List all Settlements**: Get list of settlements that contributed to the Airwallex account balance from a specified settled date, with optional filters on end settled date, currency and status.
- **List all Subscription Items**: Retrieves a list of Subscription Items based on the query parameters.
- **List all Subscriptions**: Retrieves a list of Subscriptions based on the query parameters.
- **List all Supported Financial Institutions**: Retrieve an array of Airwallex’s supported financial institutions for beneficiaries, which can be used to build your own interface. Specify the beneficiaries' attributes in your request, and use keyword to search and narrow down your results.
- **List all Tax Codes**: > Status: beta
- **List all Terminals**: List all Terminals.
- **List all Transaction Disputes**: Retrieve all transaction disputes. Filter for results using the parameters available.
- **List all Transactions**: > Status: deprecated
- **List all Transfers**: Get list of transfers from a specified creation date/time, with optional filters on end creation date/time, buy/sell currency and status. Alternatively, one or neither of the *from* or *to* created_at request fields needs to be populated. In the event that neither or only the to created_at fields ar
- **List all Webhooks**: Retrieves a list of Webhooks.
- **Mark an Invoice As Paid**: Mark a finalized Invoice that has already been paid out-of-band.
- **Obtain Access Token**: Obtain 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: Bearer [token]` header when calling other endpoints. The access token remains valid for 30 minutes and can be reused until it expires. Alway
- **Pass Review Stage of a Cardholder**: Use this endpoint to bypass the RFI process. Learn about the [cardholder status](https://www.airwallex.com/docs/issuing/get-started/create-cardholders/cardholder-statuses.md) and [Handle Cardholder Request for Information (RFI)](https://www.airwallex.com/docs/issuing/get-started/create-cardholders/h
- **Pay an Invoice**: Pay a finalized `AUTO_CHARGE` Invoice using an existing Payment Source.
- **Preview a Credit Note**: Preview a Credit Note that is linked to an Invoice.
- **Preview an Invoice**: Preview the upcoming invoice of an existing [Subscription](https://www.airwallex.com/docs/api/billing/subscriptions.md) (by specifying a `subscription_id`), or the first invoice before a new [Subscription](https://www.airwallex.com/docs/api/billing/subscriptions.md) is created (without specifying a
- **Process a Payment Intent in a Terminal**: Process a Payment Intent In a Terminal.
- **Provision a Card to a Digital Wallet**: Provisions a card into a digital wallet for in-app (push) provisioning. Available only to accounts with white-label digital wallets enabled.
- **Reactivate an Account**: Change an account status from SUSPENDED to ACTIVE, effectively reactivating it. This status change also applies to all accounts under the same client legal entity. If multiple accounts are affected, the response will include account information for all impacted accounts.
- **Redeclare a Customs Declaration**: Redeclare an existing customs declaration. `SHANGHAI_CBT` does not support redeclaration after a successful declaration.
- **Refresh a Linked Account Authentication**: Refreshes a Linked Account authentication after it has expired. You can call `/complete_auth` in onSuccess callback from the Open Banking provider to inform Airwallex it has been completed. Otherwise, the Linked Account status will remain as `REQUIRES_ACTION`.
- **Refund a Transaction for the Provided Card**: Refunds a transaction. This is only available in the sandbox environment.
- **Reject a Direct Debit Deposit**: Rejects a pending deposit by transitioning the direct debit deposit status from `PENDING` to `REJECTED`.
- **Reject a Mandate**: Reject a Mandate by transitioning the mandate status from `PROCESSING` to `INACTIVE`.
- **Reject an Account Amendment**: Use this endpoint to reject an account amendment in PENDING status. Please note that the action is asynchronous and may take some time to complete. This endpoint does not guarantee an immediate status change upon request.
- **Release a Funds Split**: Call this endpoint when you are ready to let the funds arrive at the destination. A Funds Split is capturable if `auto_release=false`.
- **Release a PSP Settlement Split**: Release the split when your Platform considers a seller ready to receive funds (for example, when a shopper has received goods). Funds are deducted from the holding account's balance, and are credited to the available balance of the respective seller connected accounts.
- **Remove Apple Pay Domains**: Remove one or more registered web domains from Apple Pay.
- **Request New Alias Verification Code**: Requests new verification code for an alias to complete the alias creation process.
- **Reset a Terminal Password**: Reset a Terminal password.
- **Resolve a Payment Dispute**: By resolving a dispute, the dispute transitions to the final status.
- **Respond to an RFI**: Allows you to respond to an RFI request by providing the required answers.
- **Restore a Meter**: Restore a Meter. The meter will be available to be linked to new Prices.
- **Retrieve a Beneficiary**: Get a specific beneficiary by specifying the Airwallex `id`.
- **Retrieve a Billing Checkout**: Retrieves a Billing Checkout.
- **Retrieve a Billing Customer**: Retrieves the details of a Billing Customer.
- **Retrieve a Billing Transaction**: Retrieves the details of a Billing Transaction.
- **Retrieve a Card**: Retrieve Card details.
- **Retrieve a Card Transaction**: Retrieve a single card transaction by its unique identifier. The response includes the current status, fund direction, merchant details, and aggregated billing amounts.
- **Retrieve a Card Transaction Event**: Retrieve a single transaction event by its unique identifier. The response includes the event type, subtype, process result, failure reason (if declined), and per-event billing and transaction amounts.
- **Retrieve a Card Transaction Lifecycle**: Retrieve a single lifecycle by its unique identifier. The response includes aggregated billing amounts across all card transactions and transaction events in this lifecycle.
- **Retrieve Account Details**: Retrieve account details for your own Airwallex account.
- **Retrieve Account Wallet Information**: Retrieve your own account number and account name which other businesses on Airwallex can find you with.
- **Retrieve a Charge**: Get the details of a charge that has previously been created. Supply the unique charge identifier that was returned at the time your created a new charge and Airwallex will return details of the corresponding charge.
- **Retrieve a Checkout Session**: > Status: early_access
- **Retrieve a Connected Account Transfer**: Get transaction details for a connected account transfer by specifying the transfer unique identifier.
- **Retrieve a Connected Store**: Gets the details of a Connected Store object by unique identifier.
- **Retrieve a Contents of a Financial Report**: Download a previously generated balance activity, transaction reconciliation, settlement or aggregated settlement reports.
- **Retrieve a Conversion**: Get a specific conversion by specifying the Airwallex `conversion_id`.
- **Retrieve a Conversion Quote**: Get a conversion quote by specifying its unique id.
- **Retrieve a Coupon**: Retrieves the coupon details by the ID.
- **Retrieve a Credit Note**: Retrieves the details of a Credit Note.
- **Retrieve a Credit Note Line Item**: Retrieves the details of a Credit Note Line Item.
- **Retrieve a Current Rate**: Retrieve a current rate for the buy/sell currency and amount. Note that the amount is validated against the upper conversion limit to ensure that a conversion for the specified amount can be executed.
- **Retrieve a Customer**: Retrieve a Customer by unique identifier. This unique identifier is first returned when creating a new Customer.
- **Retrieve a Customer Balance Transaction**: Retrieve a Customer Balance Transaction by unique ID.
- **Retrieve a Customs Declaration**: Retrieve an existing customs declaration.
- **Retrieve a Deposit**: Retrieves details of a deposit using the given deposit unique identifier.
- **Retrieve a Digital Wallet Token**: Retrieves details of a digital wallet token for a given token ID.
- **Retrieve a Direct Debit**: Get direct debit by transaction id.
- **Retrieve a Direct Debit Deposit Mandate**: Retrieves the mandate of a Linked Account using the given Linked Account unique identifier.
- **Retrieve a Direct Debit Payout Mandate**: Get a Direct Debit Payout Mandate by an Airwallex global account id and mandate id.
- **Retrieve a Financial Report**: Get a single generated balance activity, transaction reconciliation, settlement or aggregated settlement report.
- **Retrieve a Financial Transaction**: Get a specific financial transaction by an Airwallex financial transaction unique identifier.
- **Retrieve a Flow**: Get the AWX Hosted Flow instance by its unique identifier.
- **Retrieve a Funds Split**: Retrieve a Funds Split by unique identifier.
- **Retrieve a Funds Split Reversal**: Retrieve a Funds Split Reversal by unique identifier.
- **Retrieve a General Ledger Account**: > Status: beta
- **Retrieve a Global Account**: Get global account by an Airwallex global account id.
- **Retrieve a Linked Account**: Retrieves details of a Linked Account using the given Linked Account unique identifier.
- **Retrieve a Merchant Brand**: Retrieve a single merchant brand by its unique identifier.
- **Retrieve a Meter**: Retrieves the details of a Meter.
- **Retrieve an Account**: Get a connected account by unique identifier.
- **Retrieve an Account Amendment**: Get an account amendment.
- **Retrieve an Account Capability**: Get the status of a capability by providing the capability unique identifier.
- **Retrieve an Accounting Field**: > Status: beta
- **Retrieve an Accounting Field Value**: > Status: beta
- **Retrieve an Account Invitation Link**: 
- **Retrieve an Alias**: Retrieves details of an alias using the given alias ID.
- **Retrieve an Amendment**: Retrieve the details of a specific amendment using the amendment unique identifier.
- **Retrieve an Authorization**: > Status: deprecated
- **Retrieve an E-Invoicing Document**: > Status: early_access
- **Retrieve an Invoice**: Retrieves the details of an Invoice.
- **Retrieve an Invoice Line Item**: Retrieves the details of a line item on an [Invoice](https://www.airwallex.com/docs/api/billing/invoices.md).
- **Retrieve an Invoice Line Item Group**: Retrieves the details of a line item group on an [Invoice](https://www.airwallex.com/docs/api/billing/invoices.md).
- **Retrieve an Item**: Get a specific Watchlist item by specifying the Airwallex item_id.
- **Retrieve an Offboarding**: Retrieve details of a specific offboarding by its unique ID.
- **Retrieve an RFI**: Retrieves details of an RFI using the given RFI unique identifier.
- **Retrieve a Payment Attempt**: 
- **Retrieve a Payment Consent**: Retrieve a Payment Consent by unique identifier.
- **Retrieve a Payment Dispute**: Retrieve Payment Dispute information using Payment Dispute unique identifier.
- **Retrieve a Payment Intent**: Retrieve a Payment Intent by unique identifier.
- **Retrieve a Payment Link**: Retrieve information about an existing payment link.
- **Retrieve a Payment Method**: Retrieve Payment Method by unique identifier.
- **Retrieve a Payment Source**: Retrieves the details of a Payment Source.
- **Retrieve a Platform Report**: > Status: beta
- **Retrieve a Price**: Retrieves the details of a Price object by the ID.
- **Retrieve a Product**: Retrieves the product details by the ID.
- **Retrieve a Program**: > Status: beta
- **Retrieve a Program Spending Account**: > Status: beta
- **Retrieve a PSP Settlement Intent**: Get details for a PSP settlement intent by specifying the intent unique identifier.
- **Retrieve a PSP Settlement Split**: Get details for a PSP settlement split by specifying the split unique identifier.
- **Retrieve a Quote**: Get a specific quote by specifying the `quote_id`.
- **Retrieve a Rate Card**: Retrieves the details of a Rate Card.
- **Retrieve a Rate Card Item**: Retrieves the details of a Rate Card Item within a specific version, validating that the item belongs to that version.
- **Retrieve a Rate Card Version**: Retrieves a specific Rate Card Version of a Rate Card by its `version` number.
- **Retrieve a Refund**: Retrieve a Refund by unique identifier.
- **Retrieve a risk report**: Fetches the status of a risk report and, once the report is `COMPLETED`, returns a short-lived signed download link. The link is regenerated on each poll, so an expired link is replaced with a new link on the next call.
- **Retrieve a Seller**: Retrieves details of a seller using the given seller unique identifier.
- **Retrieve a Settlement**: Get a specific settlement detail by specifying the Airwallex settlement unique identifier.
- **Retrieve a Settlement Report**: Get a single batch settlement report by specifying the Airwallex settlement batch unique identifier.
- **Retrieve a Subscription**: Retrieves the details of a Subscription using the given Subscription ID.
- **Retrieve a Subscription Item**: Retrieves the details of a Subscription Item.
- **Retrieve a Tax Code**: > Status: beta
- **Retrieve a Terminal**: Retrieve a Terminal by unique identifier.
- **Retrieve a Transaction**: > Status: deprecated
- **Retrieve a Transaction Dispute**: Retrieve single transaction dispute.
- **Retrieve a Transfer**: Get a specific transfer by specifying the Airwallex `id`.
- **Retrieve a Webhook**: Retrieves the details of a Webhook.
- **Retrieve Bank Transfer Instructions of a Billing Customer**: Retrieves 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 transfer instructions have been provisioned.
- **Retrieve Summaries of a Meter**: Calculates the result of a Meter for a customer for a given time period.
- **Retrieve the API Schema**: API schema specifies the required fields and the corresponding field validation rules for each transfer scenario. A payment scenario is defined as a combination of the following parameters: beneficiary entity_type, bank_country_code. account_currency, and your preferred transfer_method, local_cleari
- **Retrieve the Balance History**: Get balance history for an account based on the transaction currency. The response contains records where each record represents a change to the balance. You can filter results using the date range parameters, `from_post_at` and `to_post_at`, representing the time the balance change occurred in your
- **Retrieve the BIN Info**: Retrieve the BIN info using the PAN passed via header param called `x-pan`.
- **Retrieve the Cardholder Details**: Retrieve details for a cardholder.
- **Retrieve the Current Reserve Plan**: Retrieves [reserve plan](https://www.airwallex.com/docs/payments/about-airwallex-payments/reserve-plan.md) configuration details for your Airwallex account.
- **Retrieve the Expiring Transfer or Deposit Limit**: Get available transfer or deposit limit that is about to expire in the next week.
- **Retrieve the Form Schema**: Form Schema can be used to build your own user interface to collect beneficiaries’ bank account and contact information. It specifies what UI component should be used to render a field along with the corresponding field validation rules. As all schema and field validation rules are maintained by Air
- **Retrieve the Issuing Config**: Retrieves the default issuing settings configured for your account.
- **Retrieve the Transfer or Deposit Limit**: Get available transfer or deposit limit.
- **Reverse a Direct Debit Deposit**: Creates a new direct debit deposit in the `SETTLED` state with an amount that offsets the original amount, i.e. negative value, and also deactivates the Linked Account. The original direct debit deposit will remain in the `SETTLED` state.
- **Reverse the Card Transaction Lifecycle with the Provided Id**: Reverse a card transaction lifecycle. This is only available in the sandbox environment.
- **Security Audit Logs**: > Status: early_access
- **Send a Payment Link**: Send an email notification to shopper with a payment link.
- **Send Threeds Notification for the Provided Card**: Use this endpoint to send a threeds delegation mode notification for the provided card. Please note that this account must enable threeds delegation mode in notification configuration. This is only available in sandbox environment.
- **Settle a Direct Debit Deposit**: Settles a pending deposit by transitioning the direct debit deposit status from `PENDING` to `SETTLED`.
- **Simulate a Shopper Action**: You can use this endpoint to simulate the shopper actions after obtaining a redirect URL for a PaymentIntent or PaymentConsent. Upon successful simulation of a shopper action on the given URL, a response with HTTP status `200 OK` and empty body will be returned. This endpoint is only available in th
- **Split a PSP Settlement Intent**: Use this endpoint to share data with Airwallex on the *funds* to be transferred to or from a target account as part of the PSP Settlement. When `settlement_type` is `CREDIT`, this is a payment to the target account. When `settlement_type` is `DEBIT`, this is a refund or chargeback.
- **Submit Alias Verification Code**: Submits 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 reached, request a new verification code using the [Request new Alias verification code](https://www.airwallex.com/docs/api/core_resources/gl
- **Submit an Account for Activation**: To complete registration of an Airwallex account, all mandatory fields and documentation must be submitted in line with the relevant business structure and jurisdiction. Please note that you must use the applicable tag that corresponds to documents uploaded as stated in the ‘Create an account’ secti
- **Submit a PSP Settlement Intent**: Submit a PSP settlement intent.
- **Submit a Transaction Dispute**: Submit a dispute to Airwallex for review and processing. After a dispute has been submitted, its status will change to SUBMITTED.
- **Supported Currencies**: Gets the client-specific list of currencies that can be bought or sold.
- **Suspend a Linked Account**: Suspend the link between your external bank account and your Airwallex account. This will also revoke any mandate objects attached to your Linked Account. To reverse this action, you will have to create a new Linked Account and go through verification.
- **Suspend an Account**: Change an account status from ACTIVE to SUSPENDED, effectively suspending it. This is a temporary status change that can be reversed with Reactivate. For official account closure, use [Create an offboarding](https://www.airwallex.com/docs/api/scale/offboardings/create.md) instead. This status change
- **Terminate a Terminal**: Terminate a Terminal.
- **Transition Transfer Status**: You can use this endpoint to simulate the status transition of your transfer. This is only available in the Sandbox environment. Learn about the [transfer status lifecycle](https://www.airwallex.com/docs/payouts/transfers/create-a-transfer/transfer-statuses.md).
- **Turn Off a Terminal**: Turns off the terminal device.
- **Turn on a Terminal**: Turns on the terminal device.
- **Update a Billing Checkout**: Updates a Billing Checkout object.
- **Update a Billing Customer**: Updates a Billing Customer. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.
- **Update a Card**: Updates card details by setting the values of the included parameters. Parameters that are not included will be left unchanged.
- **Update a Cardholder**: Update 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, then all of its child fields must be provided and valid. Updating the cardholder may re-trigger the name screening process.
- **Update a Checkout Session**: > Status: early_access
- **Update a Connected Account**: Once a new account is created and connected to yours, you can come back and update the account information following the instructions below. You can update this information prior to submitting the account for activation.
- **Update a Coupon**: Updates a coupon. Before first redemption, all fields can be adjusted; after redemption, only non-billing fields (name, description, expires_at, metadata) can be updated to maintain contractual integrity.
- **Update a Credit Note**: Update a draft Credit Note.
- **Update a Customer**: Update customer's personal information. Use the [Payment Methods API](https://www.airwallex.com/docs/api/payments/payment_methods/update.md) to update details of the attached Payment Methods.
- **Update a Customs Declaration**: Update an existing customs declaration. `SHANGHAI_CBT` does not support update after a successful declaration.
- **Update a Direct Debit Deposit Mandate**: Adds 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 and agree to the mandate to enable Direct Debits.
- **Update a General Ledger Account**: > Status: beta
- **Update a Meter**: Update a meter.
- **Update an Accounting Field**: > Status: beta
- **Update an Accounting Field Value**: > Status: beta
- **Update an Existing Beneficiary**: Edit an existing beneficiary stored on the Airwallex platform.
- **Update an Existing Global Account**: Edit an existing global account nick_name, deposit_conversion_currency or alternate_account_identifiers stored on the Airwallex platform.
- **Update an Invoice**: Updates a draft Invoice. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.
- **Update an Item**: Edit an existing Watchlist item stored on the Airwallex platform.
- **Update a Payment Consent**: Update the metadata of a Payment Consent.
- **Update a Payment Dispute**: Update a Payment Dispute by ID. Currently only the `metadata` field can be updated.
- **Update a Payment Intent**: Update properties on a Payment Intent.
- **Update a Payment Link**: Update attributes of an existing payment link.
- **Update a Payment Method**: Depending on the `payment_method_type`, you may update some of the details contained within.
- **Update a Price**: Updates 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 updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for string
- **Update a Product**: Updates a Product. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.
- **Update a PSP Settlement Intent**: Use this endpoint to update a PSP settlement intent data.
- **Update a Rate Card**: Update a Rate Card. Only `name`, `active`, `description`, and `metadata` are updatable. Other fields are immutable.
- **Update a Subscription**: Updates a Subscription. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.
- **Update a Tax Code**: > Status: beta
- **Update a Terminal**: Update a Terminal.
- **Update a Transaction Dispute**: A 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, only new evidence or explanation can be added to the dispute.
- **Update a Webhook**: Updates the attributes of an existing Webhook. Only updates to `url` are currently supported.
- **Update Credit Note Line Items in a Credit Note**: Update 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 operation is atomic, all the updates in the request will either succeed or fail together.
- **Update Invoice Line Items in an Invoice**: This is only possible when the status of an [Invoice](https://www.airwallex.com/docs/api/billing/invoices.md) is in `DRAFT`. You can update up to 100 line items at a time. This bulk operation is atomic.
- **Update Status of Connected Account**: Use this endpoint to transition the status of a connected account to one of the following: ACTIVE, SUSPENDED. The connected account must be in the SUBMITTED state to transition statuses. Learn about the [connected account status lifecycle](https://www.airwallex.com/docs/connected-accounts/onboarding
- **Update the Digital Wallet Token Status**: Only available to platforms running their own white-labelled card program. Changes a digital wallet token's status - suspend, resume, delete, or activate via call centre verification (see `operation_type` below). Applied asynchronously: Airwallex accepts the request immediately, then confirms the st
- **Update the Issuing Config**: Update issuing config (currently only support remote call config update).
- **Upload a File**: Upload a file to Airwallex using this endpoint of the `files.airwallex.com` subdomain. The max size of upload file is up to 20MB. When you upload a file, the API responds with a `file_id`. This file unique identifier can then be referenced as required as part of the attachments object in our other e
- **Validate a Beneficiary**: Given a beneficiary request, validate it and return all failed fields as a 400 response. No errors will be `"OK"` as a 200 response.
- **Validate a Transfer**: Given a transfer request, validate it and return all failed fields as a 400 response. No errors will be `"OK"` as a 200 response.
- **Verify a Beneficiary Account**: Submit beneficiary account details to verify its existance and retreive name-matching result (where supported) across supported regions and transfer methods (see [Product Docs](https://www.airwallex.com/docs/payouts/beneficiaries/verify-a-beneficiary-account.md)). The results can be used to mitigate
- **Verify a Payment Consent**: Verify 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 credentials into the Payment Consent for subsequent payments.
- **Verify Linked Account with Micro-deposits**: Verifies your Linked Account using the micro-deposit amounts received in the Linked Account.
- **Void a Credit Note**: Void 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 Invoice is unpaid.
- **Void an Invoice**: Void a finalized Invoice.
- **Void a Usage Event**: Void a previous usage event ingested within 35 days.
- **Withdraw Funds From a Program**: > Status: beta

Connect Airwallex in General Input: https://www.generalinput.com/apps/airwallex