# Airwallex

> Read balances, beneficiaries, global accounts, transfers and exchange rates; validate and manage payouts.

App · 16 actions. Web page: https://docs.lodol.com/docs/integrations/airwallex

## Actions

### Cancel transfer

Cancel transfer.

**Inputs**

- Transfer ID (`transfer_id`, text, required): Transfer id.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary_id": "example",
    "created_at": "example",
    "id": "example",
    "reference": "example",
    "request_id": "example",
    "source_currency": "example",
    "status": "example",
    "transfer_amount": 0,
    "transfer_currency": "example",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create beneficiary

Create beneficiary.

**Inputs**

- Nickname (`nickname`, text, required): Nickname.
- Beneficiary (`beneficiary`, object, required): Beneficiary.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary": {},
    "id": "example",
    "nickname": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create transfer

Create transfer.

**Inputs**

- Beneficiary (`beneficiary_id`, text, required): Choose the beneficiary or use an ID from a previous step.
- Transfer amount (`transfer_amount`, number, required): Transfer amount. At least 0.01.
- Transfer currency (`transfer_currency`, text, required): Transfer currency.
- Source currency (`source_currency`, text, required): Source currency.
- Request ID (`request_id`, text, required): A unique identifier for this operation. Reuse the same value when checking or retrying this operation to avoid duplicates.
- Reason (`reason`, text): Reason.
- Reference (`reference`, text): Reference.
- Transfer date (`transfer_date`, date): Transfer date.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary_id": "example",
    "created_at": "example",
    "id": "example",
    "reference": "example",
    "request_id": "example",
    "source_currency": "example",
    "status": "example",
    "transfer_amount": 0,
    "transfer_currency": "example",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete beneficiary

Delete beneficiary.

**Inputs**

- Beneficiary (`beneficiary_id`, text, required): Choose the beneficiary or use an ID from a previous step.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary": {},
    "id": "example",
    "nickname": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get balances

Get balances.

**Inputs**: None.

**Outputs**

- `data` (list): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Get beneficiary

Get beneficiary.

**Inputs**

- Beneficiary (`beneficiary_id`, text, required): Choose the beneficiary or use an ID from a previous step.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary": {},
    "id": "example",
    "nickname": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get conversion

Get conversion.

**Inputs**

- Conversion ID (`conversion_id`, text, required): Conversion id.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "buy_amount": 0,
    "buy_currency": "example",
    "id": "example",
    "sell_amount": 0,
    "sell_currency": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get exchange rate

Get exchange rate.

**Inputs**

- Buy currency (`buy_currency`, text, required): Buy currency.
- Sell currency (`sell_currency`, text, required): Sell currency.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get global account

Get global account.

**Inputs**

- Global account (`global_account_id`, text, required): Choose the global account or use an ID from a previous step.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "account_name": "example",
    "account_number": "example",
    "currency": "example",
    "id": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get transfer

Get transfer.

**Inputs**

- Transfer ID (`transfer_id`, text, required): Transfer id.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary_id": "example",
    "created_at": "example",
    "id": "example",
    "reference": "example",
    "request_id": "example",
    "source_currency": "example",
    "status": "example",
    "transfer_amount": 0,
    "transfer_currency": "example",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List balance history

List balance history. Returns one page; use next_cursor to continue.

**Inputs**

- Page number (`page_num`, number): Zero-based page number. Leave empty for the first page. At least 0.
- Results per page (`page_size`, number): Maximum records in this page. From 1 to 100.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List beneficiaries

List beneficiaries. Returns one page; use next_cursor to continue.

**Inputs**

- Page number (`page_num`, number): Zero-based page number. Leave empty for the first page. At least 0.
- Results per page (`page_size`, number): Maximum records in this page. From 1 to 100.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "items": [],
    "page_after": "example",
    "page_before": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List conversions

List conversions. Returns one page; use next_cursor to continue.

**Inputs**

- Page number (`page_num`, number): Zero-based page number. Leave empty for the first page. At least 0.
- Results per page (`page_size`, number): Maximum records in this page. From 1 to 100.
- From created at (`from_created_at`, date and time): From created at.
- To created at (`to_created_at`, date and time): To created at.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "items": [],
    "page_after": "example",
    "page_before": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List global accounts

List global accounts. Returns one page; use next_cursor to continue.

**Inputs**

- Page number (`page_num`, number): Zero-based page number. Leave empty for the first page. At least 0.
- Results per page (`page_size`, number): Maximum records in this page. From 1 to 100.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "items": [],
    "page_after": "example",
    "page_before": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List transfers

List transfers. Returns one page; use next_cursor to continue.

**Inputs**

- Page (`page`, text): Page.
- Results per page (`page_size`, number): Maximum records in this page. From 1 to 100.
- From created at (`from_created_at`, date and time): From created at.
- To created at (`to_created_at`, date and time): To created at.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "items": [],
    "page_after": "example",
    "page_before": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Validate transfer

Validate transfer.

**Inputs**

- Beneficiary (`beneficiary_id`, text, required): Choose the beneficiary or use an ID from a previous step.
- Transfer amount (`transfer_amount`, number, required): Transfer amount. At least 0.01.
- Transfer currency (`transfer_currency`, text, required): Transfer currency.
- Source currency (`source_currency`, text, required): Source currency.
- Request ID (`request_id`, text, required): A unique identifier for this operation. Reuse the same value when checking or retrying this operation to avoid duplicates.
- Reason (`reason`, text): Reason.
- Reference (`reference`, text): Reference.
- Transfer date (`transfer_date`, date): Transfer date.

**Outputs**

- `data` (object): Service response or returned records.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Cursor for the next page; empty when finished.

**Example output**

```json
{
  "data": {
    "beneficiary_id": "example",
    "created_at": "example",
    "id": "example",
    "reference": "example",
    "request_id": "example",
    "source_currency": "example",
    "status": "example",
    "transfer_amount": 0,
    "transfer_currency": "example",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
