Airwallex
App · 16 actions
Read balances, beneficiaries, global accounts, transfers and exchange rates; validate and manage payouts.
Actions
| Action | What it does |
|---|---|
| Cancel transfer | Cancel transfer. |
| Create beneficiary | Create beneficiary. |
| Create transfer | Create transfer. |
| Delete beneficiary | Delete beneficiary. |
| Get balances | Get balances. |
| Get beneficiary | Get beneficiary. |
| Get conversion | Get conversion. |
| Get exchange rate | Get exchange rate. |
| Get global account | Get global account. |
| Get transfer | Get transfer. |
| List balance history | List balance history. |
| List beneficiaries | List beneficiaries. |
| List conversions | List conversions. |
| List global accounts | List global accounts. |
| List transfers | List transfers. |
| Validate transfer | Validate transfer. |
Cancel transfer
Cancel transfer.
Inputs
- Transfer ID
transfer_idtextRequired - Transfer id.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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
nicknametextRequired - Nickname.
- Beneficiary
beneficiaryobjectRequired - Beneficiary.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {
"beneficiary": {},
"id": "example",
"nickname": "example"
},
"has_more": false,
"next_cursor": null
}Create transfer
Create transfer.
Inputs
- Beneficiary
beneficiary_idtextRequired - Choose the beneficiary or use an ID from a previous step.
- Transfer amount
transfer_amountnumberRequired - Transfer amount.At least 0.01.
- Transfer currency
transfer_currencytextRequired - Transfer currency.
- Source currency
source_currencytextRequired - Source currency.
- Request ID
request_idtextRequired - A unique identifier for this operation. Reuse the same value when checking or retrying this operation to avoid duplicates.
- Reason
reasontext - Reason.
- Reference
referencetext - Reference.
- Transfer date
transfer_datedate - Transfer date.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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_idtextRequired - Choose the beneficiary or use an ID from a previous step.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {
"beneficiary": {},
"id": "example",
"nickname": "example"
},
"has_more": false,
"next_cursor": null
}Get balances
Get balances.
Inputs
None.
Outputs
datalist- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}Get beneficiary
Get beneficiary.
Inputs
- Beneficiary
beneficiary_idtextRequired - Choose the beneficiary or use an ID from a previous step.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {
"beneficiary": {},
"id": "example",
"nickname": "example"
},
"has_more": false,
"next_cursor": null
}Get conversion
Get conversion.
Inputs
- Conversion ID
conversion_idtextRequired - Conversion id.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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_currencytextRequired - Buy currency.
- Sell currency
sell_currencytextRequired - Sell currency.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get global account
Get global account.
Inputs
- Global account
global_account_idtextRequired - Choose the global account or use an ID from a previous step.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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_idtextRequired - Transfer id.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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_numnumber - Zero-based page number. Leave empty for the first page.At least 0.
- Results per page
page_sizenumber - Maximum records in this page.From 1 to 100.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List beneficiaries
List beneficiaries. Returns one page; use next_cursor to continue.
Inputs
- Page number
page_numnumber - Zero-based page number. Leave empty for the first page.At least 0.
- Results per page
page_sizenumber - Maximum records in this page.From 1 to 100.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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_numnumber - Zero-based page number. Leave empty for the first page.At least 0.
- Results per page
page_sizenumber - Maximum records in this page.From 1 to 100.
- From created at
from_created_atdate and time - From created at.
- To created at
to_created_atdate and time - To created at.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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_numnumber - Zero-based page number. Leave empty for the first page.At least 0.
- Results per page
page_sizenumber - Maximum records in this page.From 1 to 100.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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
pagetext - Page.
- Results per page
page_sizenumber - Maximum records in this page.From 1 to 100.
- From created at
from_created_atdate and time - From created at.
- To created at
to_created_atdate and time - To created at.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"data": {
"items": [],
"page_after": "example",
"page_before": "example"
},
"has_more": false,
"next_cursor": null
}Validate transfer
Validate transfer.
Inputs
- Beneficiary
beneficiary_idtextRequired - Choose the beneficiary or use an ID from a previous step.
- Transfer amount
transfer_amountnumberRequired - Transfer amount.At least 0.01.
- Transfer currency
transfer_currencytextRequired - Transfer currency.
- Source currency
source_currencytextRequired - Source currency.
- Request ID
request_idtextRequired - A unique identifier for this operation. Reuse the same value when checking or retrying this operation to avoid duplicates.
- Reason
reasontext - Reason.
- Reference
referencetext - Reference.
- Transfer date
transfer_datedate - Transfer date.
Outputs
dataobject- Service response or returned records.
has_moretrue/false- Whether another page is available.
next_cursortext- Cursor for the next page; empty when finished.
Example output
{
"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
}