---
canonical_url: "https://docs.composio.dev/toolkits/airwallex"
markdown_url: "https://docs.composio.dev/toolkits/airwallex.md"
product: "platform"
version: null
last_updated: null
---

# Airwallex

Airwallex provides business accounts, payments, payouts, foreign exchange, cards, and financial operations through a unified global financial platform.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `AIRWALLEX`
- **Version:** 00000000_00

## Tools

### Get Current Account

**Slug:** `AIRWALLEX_GET_CURRENT_ACCOUNT`

Retrieve identity, status, and profile details for the connected Airwallex account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Balances

**Slug:** `AIRWALLEX_GET_CURRENT_BALANCES`

Return available, pending, reserved, prepayment, and total balances by currency for an Airwallex account type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_type` | string ("cash" | "yield" | "credit") | No | Balance account type to query: cash, yield, or credit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supported Conversion Currencies

**Slug:** `AIRWALLEX_GET_SUPPORTED_CONVERSION_CURRENCIES`

Return the connected client's currencies supported for buying and selling in conversions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Beneficiaries

**Slug:** `AIRWALLEX_LIST_BENEFICIARIES`

List beneficiaries, optionally filtered by identity, bank account, entity type, or creation date. Returns one page and a cursor for continuation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter by beneficiary name. |
| `to_date` | string | No | Inclusive ISO-8601 upper bound for creation time. |
| `from_date` | string | No | Inclusive ISO-8601 lower bound for creation time. |
| `nick_name` | string | No | Filter by beneficiary nickname. |
| `page_size` | integer | No | Maximum beneficiaries in this page (minimum 10); the provider maximum is not yet verified. |
| `entity_type` | string ("COMPANY" | "PERSONAL") | No | Filter by COMPANY or PERSONAL beneficiary. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `company_name` | string | No | Filter by beneficiary company name. |
| `bank_account_number` | string | No | Filter by beneficiary bank account number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversions

**Slug:** `AIRWALLEX_LIST_CONVERSIONS`

List recent currency conversions, optionally filtered by currencies, request ID, status, or creation time. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("SCHEDULED" | "OVERDUE" | "CANCELLED" | "SETTLED") | No | Filter by conversion status. |
| `page_size` | integer | No | Maximum conversions in this page; the provider maximum is not yet verified. |
| `request_id` | string | No | Filter by the client-supplied conversion request ID. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `buy_currency` | string | No | Filter by the 3-letter ISO-4217 currency bought. |
| `sell_currency` | string | No | Filter by the 3-letter ISO-4217 currency sold. |
| `to_created_at` | string | No | Inclusive ISO-8601 upper bound for conversion creation time. |
| `from_created_at` | string | No | Inclusive ISO-8601 lower bound for conversion creation time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Global Accounts

**Slug:** `AIRWALLEX_LIST_GLOBAL_ACCOUNTS`

List global accounts, optionally filtered by country, currency, nickname, status, or creation time. Returns one page and an Airwallex bookmark cursor when another page is available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string | No | Filter by global-account status. |
| `currency` | string | No | Filter by 3-letter ISO-4217 currency code. |
| `nick_name` | string | No | Filter by global-account nickname. |
| `page_size` | integer | No | Maximum global accounts in this page (minimum 10); the provider maximum is not yet verified. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `country_code` | string | No | Filter by 2-letter ISO country code. |
| `to_created_at` | string | No | Inclusive ISO-8601 upper bound for creation time. |
| `from_created_at` | string | No | Inclusive ISO-8601 lower bound for creation time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transfers

**Slug:** `AIRWALLEX_LIST_TRANSFERS`

List one page of transfers created by the connected Airwallex account, optionally filtered by currency, destination, request ID, status, or creation time. Pass the returned cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("NEW" | "SETTLED" | "PENDING" | "SUSPENDED" | "FAILED") | No | Filter by transfer status. |
| `currency` | string | No | Filter by 3-letter ISO-4217 currency code. |
| `page_size` | integer | No | Maximum transfers in this page (10-2000). |
| `request_id` | string | No | Filter by the client-supplied transfer request ID. |
| `destination` | string | No | Filter by destination Airwallex account ID. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `to_created_at` | string | No | Inclusive ISO-8601 upper bound for transfer creation time. |
| `from_created_at` | string | No | Inclusive ISO-8601 lower bound for transfer creation time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |