Airwallex

App · 16 actions

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

Actions

ActionWhat it does
Cancel transferCancel transfer.
Create beneficiaryCreate beneficiary.
Create transferCreate transfer.
Delete beneficiaryDelete beneficiary.
Get balancesGet balances.
Get beneficiaryGet beneficiary.
Get conversionGet conversion.
Get exchange rateGet exchange rate.
Get global accountGet global account.
Get transferGet transfer.
List balance historyList balance history.
List beneficiariesList beneficiaries.
List conversionsList conversions.
List global accountsList global accounts.
List transfersList transfers.
Validate transferValidate transfer.

Cancel transfer

Cancel transfer.

Inputs

Transfer IDtransfer_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

NicknamenicknametextRequired
Nickname.
BeneficiarybeneficiaryobjectRequired
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

Beneficiarybeneficiary_idtextRequired
Choose the beneficiary or use an ID from a previous step.
Transfer amounttransfer_amountnumberRequired
Transfer amount.At least 0.01.
Transfer currencytransfer_currencytextRequired
Transfer currency.
Source currencysource_currencytextRequired
Source currency.
Request IDrequest_idtextRequired
A unique identifier for this operation. Reuse the same value when checking or retrying this operation to avoid duplicates.
Reasonreasontext
Reason.
Referencereferencetext
Reference.
Transfer datetransfer_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

Beneficiarybeneficiary_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

Beneficiarybeneficiary_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 IDconversion_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 currencybuy_currencytextRequired
Buy currency.
Sell currencysell_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 accountglobal_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 IDtransfer_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 numberpage_numnumber
Zero-based page number. Leave empty for the first page.At least 0.
Results per pagepage_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 numberpage_numnumber
Zero-based page number. Leave empty for the first page.At least 0.
Results per pagepage_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 numberpage_numnumber
Zero-based page number. Leave empty for the first page.At least 0.
Results per pagepage_sizenumber
Maximum records in this page.From 1 to 100.
From created atfrom_created_atdate and time
From created at.
To created atto_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 numberpage_numnumber
Zero-based page number. Leave empty for the first page.At least 0.
Results per pagepage_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

Pagepagetext
Page.
Results per pagepage_sizenumber
Maximum records in this page.From 1 to 100.
From created atfrom_created_atdate and time
From created at.
To created atto_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

Beneficiarybeneficiary_idtextRequired
Choose the beneficiary or use an ID from a previous step.
Transfer amounttransfer_amountnumberRequired
Transfer amount.At least 0.01.
Transfer currencytransfer_currencytextRequired
Transfer currency.
Source currencysource_currencytextRequired
Source currency.
Request IDrequest_idtextRequired
A unique identifier for this operation. Reuse the same value when checking or retrying this operation to avoid duplicates.
Reasonreasontext
Reason.
Referencereferencetext
Reference.
Transfer datetransfer_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
}

On this page