Can I use Airwallex as a CLI?

Yes. KosmoKrator exposes a Airwallex CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Airwallex through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Airwallex tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Airwallex credentials stored?

Airwallex credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Airwallex MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Airwallex Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Airwallex KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.airwallex.*. Use lua_read_doc("integrations.airwallex") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Airwallex workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.airwallex.obtain_access_token({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("airwallex"))' --json
kosmo integrations:lua --eval 'print(docs.read("airwallex.obtain_access_token"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local airwallex = app.integrations.airwallex
local result = airwallex.obtain_access_token({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.airwallex, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.airwallex.default.* or app.integrations.airwallex.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Airwallex, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Airwallex Integration

Use the airwallex integration to work with Airwallex authentication, billing, issuing, payment acceptance, payouts, reporting, Scale connected accounts, sandbox simulations, file upload, transactional FX, and treasury APIs.

This package is generated from Airwallex’s official public Postman collection linked from the Airwallex API quickstart docs. It exposes 201 unique Airwallex endpoints from the Airwallex Public API v2025-11-11 collection. Duplicate examples that map to the same HTTP method and path are intentionally de-duplicated into one endpoint tool.

Authentication

airwallex_authentication_obtain_access_token calls /api/v1/authentication/login with x-client-id and x-api-key headers.
Runtime tools use Authorization: Bearer <access_token>.
Airwallex access tokens expire quickly. Reuse the token until its expires_at value, then call the login tool again.
url defaults to https://api-demo.airwallex.com; file_url defaults to https://files-demo.airwallex.com.

Request Shape

Path, query, and optional Airwallex headers are exposed as snake_case tool parameters. JSON and multipart request bodies are passed through the body object and should match the Airwallex API request shape for that endpoint. Multipart file fields may be local file paths.

Return Shape

JSON responses are returned as decoded arrays/objects from Airwallex. Empty successful responses return { success = true, status = <http_status>, location = <location_header> } when a Location header is present.

Examples

local token = app.integrations.airwallex.authentication_obtain_access_token({})

local account = app.integrations.airwallex.scale_retrieve_account_details({})

local customers = app.integrations.airwallex.billing_get_list_of_blling_customers({
  page_num = "0",
  page_size = "20"
})

Use fake account IDs, customer IDs, card IDs, payment IDs, transfer IDs, API keys, client IDs, and access tokens in tests and examples. Never store real Airwallex credentials, customer details, payment details, card data, bank account details, or production account IDs in fixtures or Lua examples.

Raw agent markdown

# Airwallex Integration

Use the `airwallex` integration to work with Airwallex authentication, billing, issuing, payment acceptance, payouts, reporting, Scale connected accounts, sandbox simulations, file upload, transactional FX, and treasury APIs.

This package is generated from Airwallex's official public Postman collection linked from the Airwallex API quickstart docs. It exposes 201 unique Airwallex endpoints from the `Airwallex Public API v2025-11-11` collection. Duplicate examples that map to the same HTTP method and path are intentionally de-duplicated into one endpoint tool.

## Authentication

- `airwallex_authentication_obtain_access_token` calls `/api/v1/authentication/login` with `x-client-id` and `x-api-key` headers.
- Runtime tools use `Authorization: Bearer <access_token>`.
- Airwallex access tokens expire quickly. Reuse the token until its `expires_at` value, then call the login tool again.
- `url` defaults to `https://api-demo.airwallex.com`; `file_url` defaults to `https://files-demo.airwallex.com`.

## Request Shape

Path, query, and optional Airwallex headers are exposed as snake_case tool parameters. JSON and multipart request bodies are passed through the `body` object and should match the Airwallex API request shape for that endpoint. Multipart file fields may be local file paths.

## Return Shape

JSON responses are returned as decoded arrays/objects from Airwallex. Empty successful responses return `{ success = true, status = <http_status>, location = <location_header> }` when a Location header is present.

## Examples

```lua
local token = app.integrations.airwallex.authentication_obtain_access_token({})

local account = app.integrations.airwallex.scale_retrieve_account_details({})

local customers = app.integrations.airwallex.billing_get_list_of_blling_customers({
  page_num = "0",
  page_size = "20"
})
```

Use fake account IDs, customer IDs, card IDs, payment IDs, transfer IDs, API keys, client IDs, and access tokens in tests and examples. Never store real Airwallex credentials, customer details, payment details, card data, bank account details, or production account IDs in fixtures or Lua examples.

Metadata-derived Lua example

local result = app.integrations.airwallex.obtain_access_token({})
print(result)

Functions

obtain_access_token Read

Authentication > API Access > Obtain access token. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/authentication/login.

Lua path: app.integrations.airwallex.obtain_access_token
Full name: airwallex.airwallex_authentication_obtain_access_token

Parameter	Type	Required	Description
No parameters.

create_billing_customer Write

Billing > Billing Customers > Create a Billing Customer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/billing_customers/create.

Lua path: app.integrations.airwallex.create_billing_customer
Full name: airwallex.airwallex_billing_create_a_billing_customer

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_billing_customer Write

Billing > Billing Customers > Update a Billing Customer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/billing_customers/{billing_customer_id}/update.

Lua path: app.integrations.airwallex.update_billing_customer
Full name: airwallex.airwallex_billing_update_a_billing_customer

Parameter	Type	Required	Description
`billing_customer_id`	string	yes	Path parameter `billing_customer_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_billing_customer Read

Billing > Billing Customers > Retrieve a Billing Customer. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/billing_customers/{billing_customer_id}.

Lua path: app.integrations.airwallex.retrieve_billing_customer
Full name: airwallex.airwallex_billing_retrieve_a_billing_customer

Parameter	Type	Required	Description
`billing_customer_id`	string	yes	Path parameter `billing_customer_id`.

get_list_blling_customers Read

Billing > Billing Customers > Get list of Blling Customers. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/billing_customers.

Lua path: app.integrations.airwallex.get_list_blling_customers
Full name: airwallex.airwallex_billing_get_list_of_blling_customers

Parameter	Type	Required	Description
No parameters.

create_product Write

Billing > Products > Create a Product. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/products/create.

Lua path: app.integrations.airwallex.create_product
Full name: airwallex.airwallex_billing_create_a_product

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_product Write

Billing > Products > Update a Product. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/products/{product_id}/update.

Lua path: app.integrations.airwallex.update_product
Full name: airwallex.airwallex_billing_update_a_product

Parameter	Type	Required	Description
`product_id`	string	yes	Path parameter `product_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_product Read

Billing > Products > Retrieve a Product. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/products/{product_id}.

Lua path: app.integrations.airwallex.retrieve_product
Full name: airwallex.airwallex_billing_retrieve_a_product

Parameter	Type	Required	Description
`product_id`	string	yes	Path parameter `product_id`.

get_list_products Read

Billing > Products > Get list of Products. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/products.

Lua path: app.integrations.airwallex.get_list_products
Full name: airwallex.airwallex_billing_get_list_of_products

Parameter	Type	Required	Description
No parameters.

create_price_per_unit_one_off Write

Billing > Prices > Create a Price - Per unit one off. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/prices/create.

Lua path: app.integrations.airwallex.create_price_per_unit_one_off
Full name: airwallex.airwallex_billing_create_a_price_per_unit_one_off

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_price Write

Billing > Prices > Update a Price. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/prices/{price_id}/update.

Lua path: app.integrations.airwallex.update_price
Full name: airwallex.airwallex_billing_update_a_price

Parameter	Type	Required	Description
`price_id`	string	yes	Path parameter `price_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_price Read

Billing > Prices > Retrieve a Price. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/prices/{price_id}.

Lua path: app.integrations.airwallex.retrieve_price
Full name: airwallex.airwallex_billing_retrieve_a_price

Parameter	Type	Required	Description
`price_id`	string	yes	Path parameter `price_id`.

get_list_prices Read

Billing > Prices > Get list of Prices. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/prices.

Lua path: app.integrations.airwallex.get_list_prices
Full name: airwallex.airwallex_billing_get_list_of_prices

Parameter	Type	Required	Description
No parameters.

create_billing_checkout_payment Write

Billing > Billing Checkouts > Create a Billing Checkout - Payment. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/billing_checkouts/create.

Lua path: app.integrations.airwallex.create_billing_checkout_payment
Full name: airwallex.airwallex_billing_create_a_billing_checkout_payment

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_billing_checkout Write

Billing > Billing Checkouts > Update a Billing Checkout. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/billing_checkouts/{billing_checkout_id}/update.

Lua path: app.integrations.airwallex.update_billing_checkout
Full name: airwallex.airwallex_billing_update_a_billing_checkout

Parameter	Type	Required	Description
`billing_checkout_id`	string	yes	Path parameter `billing_checkout_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_billing_checkout Read

Billing > Billing Checkouts > Retrieve a Billing checkout. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/billing_checkouts/{billing_checkout_id}.

Lua path: app.integrations.airwallex.retrieve_billing_checkout
Full name: airwallex.airwallex_billing_retrieve_a_billing_checkout

Parameter	Type	Required	Description
`billing_checkout_id`	string	yes	Path parameter `billing_checkout_id`.

get_list_billing_checkouts Read

Billing > Billing Checkouts > Get list of Billing Checkouts. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/billing_checkouts.

Lua path: app.integrations.airwallex.get_list_billing_checkouts
Full name: airwallex.airwallex_billing_get_list_of_billing_checkouts

Parameter	Type	Required	Description
No parameters.

cancel_billing_checkout Write

Billing > Billing Checkouts > Cancel a Billing Checkout. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/billing_checkouts/{billing_checkout_id}/cancel.

Lua path: app.integrations.airwallex.cancel_billing_checkout
Full name: airwallex.airwallex_billing_cancel_a_billing_checkout

Parameter	Type	Required	Description
`billing_checkout_id`	string	yes	Path parameter `billing_checkout_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_invoice Write

Billing > Invoices > Create an Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/create.

Lua path: app.integrations.airwallex.create_invoice
Full name: airwallex.airwallex_billing_create_an_invoice

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

preview_invoice Read

Billing > Invoices > Preview an Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/preview.

Lua path: app.integrations.airwallex.preview_invoice
Full name: airwallex.airwallex_billing_preview_an_invoice

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_invoice Write

Billing > Invoices > Update an Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/{invoice_id}/update.

Lua path: app.integrations.airwallex.update_invoice
Full name: airwallex.airwallex_billing_update_an_invoice

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

delete_draft_invoice Write

Billing > Invoices > Delete a Draft Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/{invoice_id}/delete.

Lua path: app.integrations.airwallex.delete_draft_invoice
Full name: airwallex.airwallex_billing_delete_a_draft_invoice

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.

retrieve_invoice Read

Billing > Invoices > Retrieve an Invoice. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/invoices/{invoice_id}.

Lua path: app.integrations.airwallex.retrieve_invoice
Full name: airwallex.airwallex_billing_retrieve_an_invoice

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.

get_list_invoices Read

Billing > Invoices > Get list of Invoices. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/invoices.

Lua path: app.integrations.airwallex.get_list_invoices
Full name: airwallex.airwallex_billing_get_list_of_invoices

Parameter	Type	Required	Description
No parameters.

finalize_invoice Read

Billing > Invoices > Finalize an Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/{invoice_id}/finalize.

Lua path: app.integrations.airwallex.finalize_invoice
Full name: airwallex.airwallex_billing_finalize_an_invoice

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.

mark_invoice_paid Write

Billing > Invoices > Mark an Invoice as Paid. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/{invoice_id}/mark_as_paid.

Lua path: app.integrations.airwallex.mark_invoice_paid
Full name: airwallex.airwallex_billing_mark_an_invoice_as_paid

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.

void_invoice Read

Billing > Invoices > Void an Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/{invoice_id}/void.

Lua path: app.integrations.airwallex.void_invoice
Full name: airwallex.airwallex_billing_void_an_invoice

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.

create_invoice_line_items_and_add_them_invoice Write

Billing > Invoices > Create Invoice Line Items and add them to an Invoice. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/invoices/{invoice_id}/add_line_items.

Lua path: app.integrations.airwallex.create_invoice_line_items_and_add_them_invoice
Full name: airwallex.airwallex_billing_create_invoice_line_items_and_add_them_to_an_invoice

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_invoices_line_items Read

Billing > Invoices > Get list of Invoices Line Items. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/invoices/{invoice_id}/line_items.

Lua path: app.integrations.airwallex.get_list_invoices_line_items
Full name: airwallex.airwallex_billing_get_list_of_invoices_line_items

Parameter	Type	Required	Description
`invoice_id`	string	yes	Path parameter `invoice_id`.

get_billing_transaction Read

Billing > Billing Transactions > Get a Billing Transaction. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/billing_transactions/{billing_transaction_id}.

Lua path: app.integrations.airwallex.get_billing_transaction
Full name: airwallex.airwallex_billing_get_a_billing_transaction

Parameter	Type	Required	Description
`billing_transaction_id`	string	yes	Path parameter `billing_transaction_id`.

get_list_billing_transactions Read

Billing > Billing Transactions > Get a list of Billing Transactions. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/billing_transactions.

Lua path: app.integrations.airwallex.get_list_billing_transactions
Full name: airwallex.airwallex_billing_get_a_list_of_billing_transactions

Parameter	Type	Required	Description
`invoice_id`	string	no	Query parameter `invoice_id`.

create_coupon Write

Billing > Coupons > Create a Coupon. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/coupons/create.

Lua path: app.integrations.airwallex.create_coupon
Full name: airwallex.airwallex_billing_create_a_coupon

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_coupon Write

Billing > Coupons > Update a Coupon. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/coupons/{coupon_id}/update.

Lua path: app.integrations.airwallex.update_coupon
Full name: airwallex.airwallex_billing_update_a_coupon

Parameter	Type	Required	Description
`coupon_id`	string	yes	Path parameter `coupon_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_coupon Read

Billing > Coupons > Get a Coupon. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/coupons/{coupon_id}.

Lua path: app.integrations.airwallex.get_coupon
Full name: airwallex.airwallex_billing_get_a_coupon

Parameter	Type	Required	Description
`coupon_id`	string	yes	Path parameter `coupon_id`.

get_list_coupons Read

Billing > Coupons > Get list of Coupons. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/coupons.

Lua path: app.integrations.airwallex.get_list_coupons
Full name: airwallex.airwallex_billing_get_list_of_coupons

Parameter	Type	Required	Description
No parameters.

create_payment_source Write

Billing > Payment Sources > Create a Payment Source. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/payment_sources/create.

Lua path: app.integrations.airwallex.create_payment_source
Full name: airwallex.airwallex_billing_create_a_payment_source

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_payment_source Read

Billing > Payment Sources > Get a Payment Source. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/payment_sources/{payment_source_id}.

Lua path: app.integrations.airwallex.get_payment_source
Full name: airwallex.airwallex_billing_get_a_payment_source

Parameter	Type	Required	Description
`payment_source_id`	string	yes	Path parameter `payment_source_id`.

get_list_payment_sources Read

Billing > Payment Sources > Get List of Payment Sources. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/payment_sources.

Lua path: app.integrations.airwallex.get_list_payment_sources
Full name: airwallex.airwallex_billing_get_list_of_payment_sources

Parameter	Type	Required	Description
No parameters.

create_meter Write

Billing > Meters > Create a Meter. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/meters/create.

Lua path: app.integrations.airwallex.create_meter
Full name: airwallex.airwallex_billing_create_a_meter

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_meter Write

Billing > Meters > Update a Meter. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/meters/{meter_id}/update.

Lua path: app.integrations.airwallex.update_meter
Full name: airwallex.airwallex_billing_update_a_meter

Parameter	Type	Required	Description
`meter_id`	string	yes	Path parameter `meter_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_meter Read

Billing > Meters > Retrieve a Meter. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/meters/{meter_id}.

Lua path: app.integrations.airwallex.retrieve_meter
Full name: airwallex.airwallex_billing_retrieve_a_meter

Parameter	Type	Required	Description
`meter_id`	string	yes	Path parameter `meter_id`.

archive_meter Write

Billing > Meters > Archive a Meter. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/meters/{meter_id}/archive.

Lua path: app.integrations.airwallex.archive_meter
Full name: airwallex.airwallex_billing_archive_a_meter

Parameter	Type	Required	Description
`meter_id`	string	yes	Path parameter `meter_id`.

restore_meter Read

Billing > Meters > Restore a Meter. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/meters/{meter_id}/restore.

Lua path: app.integrations.airwallex.restore_meter
Full name: airwallex.airwallex_billing_restore_a_meter

Parameter	Type	Required	Description
`meter_id`	string	yes	Path parameter `meter_id`.

get_list_meters Read

Billing > Meters > Get list of Meters. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/meters.

Lua path: app.integrations.airwallex.get_list_meters
Full name: airwallex.airwallex_billing_get_list_of_meters

Parameter	Type	Required	Description
No parameters.

get_summaries_meter Read

Billing > Meters > Get summaries of a Meter. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/meters/{meter_id}/summaries.

Lua path: app.integrations.airwallex.get_summaries_meter
Full name: airwallex.airwallex_billing_get_summaries_of_a_meter

Parameter	Type	Required	Description
`meter_id`	string	yes	Path parameter `meter_id`.
`billing_customer_id`	string	no	Query parameter `billing_customer_id`.
`from_happened_at`	string	no	Query parameter `from_happened_at`.
`to_happened_at`	string	no	Query parameter `to_happened_at`.

ingest_usage_event Read

Billing > Usage Events > Ingest a Usage Event. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/usage_events/ingest.

Lua path: app.integrations.airwallex.ingest_usage_event
Full name: airwallex.airwallex_billing_ingest_a_usage_event

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

batch_ingest_usage_events Read

Billing > Usage Events > Batch Ingest Usage Events. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/usage_events/batch_ingest.

Lua path: app.integrations.airwallex.batch_ingest_usage_events
Full name: airwallex.airwallex_billing_batch_ingest_usage_events

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

void_usage_event Read

Billing > Usage Events > Void a Usage Event. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/usage_events/void.

Lua path: app.integrations.airwallex.void_usage_event
Full name: airwallex.airwallex_billing_void_a_usage_event

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_subscription_checkout Write

Billing > Subscriptions > Create a Subscription - Checkout. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/subscriptions/create.

Lua path: app.integrations.airwallex.create_subscription_checkout
Full name: airwallex.airwallex_billing_create_a_subscription_checkout

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_subscription Read

Billing > Subscriptions > Retrieve a Subscription. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/subscriptions/{subscription_id}.

Lua path: app.integrations.airwallex.retrieve_subscription
Full name: airwallex.airwallex_billing_retrieve_a_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	Path parameter `subscription_id`.

update_subscription Write

Billing > Subscriptions > Update a Subscription. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/subscriptions/{subscription_id}/update.

Lua path: app.integrations.airwallex.update_subscription
Full name: airwallex.airwallex_billing_update_a_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	Path parameter `subscription_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

cancel_subscription Write

Billing > Subscriptions > Cancel a Subscription. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/subscriptions/{subscription_id}/cancel.

Lua path: app.integrations.airwallex.cancel_subscription
Full name: airwallex.airwallex_billing_cancel_a_subscription

Parameter	Type	Required	Description
`subscription_id`	string	yes	Path parameter `subscription_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_subscriptions Read

Billing > Subscriptions > Get list of Subscriptions. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/subscriptions.

Lua path: app.integrations.airwallex.get_list_subscriptions
Full name: airwallex.airwallex_billing_get_list_of_subscriptions

Parameter	Type	Required	Description
No parameters.

get_authorization_status Read

Issuing > Authorizations > Get authorization status. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/authorizations.

Lua path: app.integrations.airwallex.get_authorization_status
Full name: airwallex.airwallex_issuing_get_authorization_status

Parameter	Type	Required	Description
No parameters.

get_single_authorization_status Read

Issuing > Authorizations > Get single authorization status. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/authorizations/{issuing_transaction_id}.

Lua path: app.integrations.airwallex.get_single_authorization_status
Full name: airwallex.airwallex_issuing_get_single_authorization_status

Parameter	Type	Required	Description
`issuing_transaction_id`	string	yes	Path parameter `issuing_transaction_id`.

create_cardholder Write

Issuing > Cardholders > Create a cardholder. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/issuing/cardholders/create.

Lua path: app.integrations.airwallex.create_cardholder
Full name: airwallex.airwallex_issuing_create_a_cardholder

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_cardholders Read

Issuing > Cardholders > Get all cardholders. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/cardholders.

Lua path: app.integrations.airwallex.get_cardholders
Full name: airwallex.airwallex_issuing_get_all_cardholders

Parameter	Type	Required	Description
No parameters.

get_cardholder_details Read

Issuing > Cardholders > Get cardholder details. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/cardholders/{cardholder_id}.

Lua path: app.integrations.airwallex.get_cardholder_details
Full name: airwallex.airwallex_issuing_get_cardholder_details

Parameter	Type	Required	Description
`cardholder_id`	string	yes	Path parameter `cardholder_id`.

update_cardholder Write

Issuing > Cardholders > Update a cardholder. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/issuing/cardholders/{cardholder_id}/update.

Lua path: app.integrations.airwallex.update_cardholder
Full name: airwallex.airwallex_issuing_update_a_cardholder

Parameter	Type	Required	Description
`cardholder_id`	string	yes	Path parameter `cardholder_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_card Write

Issuing > Cards > Create a card. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/issuing/cards/create.

Lua path: app.integrations.airwallex.create_card
Full name: airwallex.airwallex_issuing_create_a_card

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_cards Read

Issuing > Cards > Get all cards. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/cards.

Lua path: app.integrations.airwallex.get_cards
Full name: airwallex.airwallex_issuing_get_all_cards

Parameter	Type	Required	Description
No parameters.

get_sensitive_card_details Read

Issuing > Cards > Get sensitive card details. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/cards/{card_id}/details.

Lua path: app.integrations.airwallex.get_sensitive_card_details
Full name: airwallex.airwallex_issuing_get_sensitive_card_details

Parameter	Type	Required	Description
`card_id`	string	yes	Path parameter `card_id`.

activate_card Write

Issuing > Cards > Activate a card. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/issuing/cards/{card_id}/activate.

Lua path: app.integrations.airwallex.activate_card
Full name: airwallex.airwallex_issuing_activate_a_card

Parameter	Type	Required	Description
`card_id`	string	yes	Path parameter `card_id`.

get_card_details Read

Issuing > Cards > Get card details. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/cards/{card_id}.

Lua path: app.integrations.airwallex.get_card_details
Full name: airwallex.airwallex_issuing_get_card_details

Parameter	Type	Required	Description
`card_id`	string	yes	Path parameter `card_id`.

get_card_remaining_limits Read

Issuing > Cards > Get card remaining limits. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/cards/{card_id}/limits.

Lua path: app.integrations.airwallex.get_card_remaining_limits
Full name: airwallex.airwallex_issuing_get_card_remaining_limits

Parameter	Type	Required	Description
`card_id`	string	yes	Path parameter `card_id`.

update_card Write

Issuing > Cards > Update a card. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/issuing/cards/{card_id}/update.

Lua path: app.integrations.airwallex.update_card
Full name: airwallex.airwallex_issuing_update_a_card

Parameter	Type	Required	Description
`card_id`	string	yes	Path parameter `card_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_issuing_config Read

Issuing > Config > Get issuing config. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/config.

Lua path: app.integrations.airwallex.get_issuing_config
Full name: airwallex.airwallex_issuing_get_issuing_config

Parameter	Type	Required	Description
No parameters.

update_issuing_config Write

Issuing > Config > Update issuing config. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/issuing/config/update.

Lua path: app.integrations.airwallex.update_issuing_config
Full name: airwallex.airwallex_issuing_update_issuing_config

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_transactions Read

Issuing > Transactions > Get transactions. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/transactions.

Lua path: app.integrations.airwallex.get_transactions
Full name: airwallex.airwallex_issuing_get_transactions

Parameter	Type	Required	Description
No parameters.

get_single_transaction Read

Issuing > Transactions > Get single transaction. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/issuing/transactions/{issuing_transaction_id}.

Lua path: app.integrations.airwallex.get_single_transaction
Full name: airwallex.airwallex_issuing_get_single_transaction

Parameter	Type	Required	Description
`issuing_transaction_id`	string	yes	Path parameter `issuing_transaction_id`.

retrieve_available_payment_method_types Read

Online Payments > Config > Retrieve available payment method types. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/config/payment_method_types.

Lua path: app.integrations.airwallex.retrieve_available_payment_method_types
Full name: airwallex.airwallex_online_payments_retrieve_available_payment_method_types

Parameter	Type	Required	Description
`active`	string	no	Indicate whether the payment method type is active
`country_code`	string	no	The supported country code.
`transaction_currency`	string	no	The supported transaction currency. transaction_currency is required when country_code is given.
`transaction_mode`	string	no	The supported transaction mode. One of oneoff, recurring.

retrieve_bank_names_certain_payment_method_types Read

Online Payments > Config > Retrieve bank names for certain payment method types. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/config/banks.

Lua path: app.integrations.airwallex.retrieve_bank_names_certain_payment_method_types
Full name: airwallex.airwallex_online_payments_retrieve_bank_names_for_certain_payment_method_types

Parameter	Type	Required	Description
`payment_method_type`	string	no	The payment method type to find the available banks. One of fpx, bank_transfer, online_banking. For other payment methods that does not require bank_name, an empty list will be returned.
`country_code`	string	no	Country code to filter the available banks. Use the two-character ISO Standard Country Codes. For payment method type like online_banking and bank_transfer, the available bank list differs in different countries and country_code is needed to get the bank list. For other payment method types, country_code will be ignored.

create_customer Write

Online Payments > Customers > Create a Customer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/customers/create.

Lua path: app.integrations.airwallex.create_customer
Full name: airwallex.airwallex_online_payments_create_a_customer

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_customer Read

Online Payments > Customers > Retrieve a Customer. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/customers/{customer_id}.

Lua path: app.integrations.airwallex.retrieve_customer
Full name: airwallex.airwallex_online_payments_retrieve_a_customer

Parameter	Type	Required	Description
`customer_id`	string	yes	Path parameter `customer_id`.

update_customer Write

Online Payments > Customers > Update a Customer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/customers/{customer_id}/update.

Lua path: app.integrations.airwallex.update_customer
Full name: airwallex.airwallex_online_payments_update_a_customer

Parameter	Type	Required	Description
`customer_id`	string	yes	Path parameter `customer_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

generate_client_secret_customer Read

Online Payments > Customers > Generate a client secret for a Customer. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/customers/{customer_id}/generate_client_secret.

Lua path: app.integrations.airwallex.generate_client_secret_customer
Full name: airwallex.airwallex_online_payments_generate_a_client_secret_for_a_customer

Parameter	Type	Required	Description
`customer_id`	string	yes	Path parameter `customer_id`.

get_list_customers Read

Online Payments > Customers > Get list of Customers. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/customers.

Lua path: app.integrations.airwallex.get_list_customers
Full name: airwallex.airwallex_online_payments_get_list_of_customers

Parameter	Type	Required	Description
No parameters.

create_customs_declaration Write

Online Payments > Customs Declarations > Create a customs declaration. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/customs_declarations/create.

Lua path: app.integrations.airwallex.create_customs_declaration
Full name: airwallex.airwallex_online_payments_create_a_customs_declaration

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_fundssplit Write

Online Payments > Fund Splits > Create a FundsSplit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/funds_splits/create.

Lua path: app.integrations.airwallex.create_fundssplit
Full name: airwallex.airwallex_online_payments_create_a_fundssplit

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_fundssplit Read

Online Payments > Fund Splits > Retrieve a FundsSplit. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/funds_splits/{fund_split_id}.

Lua path: app.integrations.airwallex.retrieve_fundssplit
Full name: airwallex.airwallex_online_payments_retrieve_a_fundssplit

Parameter	Type	Required	Description
`fund_split_id`	string	yes	Path parameter `fund_split_id`.

get_list_fundssplits Read

Online Payments > Fund Splits > Get list of FundsSplits. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/funds_splits.

Lua path: app.integrations.airwallex.get_list_fundssplits
Full name: airwallex.airwallex_online_payments_get_list_of_fundssplits

Parameter	Type	Required	Description
No parameters.

release_fundssplit Read

Online Payments > Fund Splits > Release a FundsSplit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/funds_splits/{fund_split_id}/release.

Lua path: app.integrations.airwallex.release_fundssplit
Full name: airwallex.airwallex_online_payments_release_a_fundssplit

Parameter	Type	Required	Description
`fund_split_id`	string	yes	Path parameter `fund_split_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_paymentattempt_by_id Read

Online Payments > Payment Attempts > Retrieve a PaymentAttempt by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_attempts/{payment_attempt_id}.

Lua path: app.integrations.airwallex.retrieve_paymentattempt_by_id
Full name: airwallex.airwallex_online_payments_retrieve_a_paymentattempt_by_id

Parameter	Type	Required	Description
`payment_attempt_id`	string	yes	Path parameter `payment_attempt_id`.

retrieve_list_paymentattempts Read

Online Payments > Payment Attempts > Retrieve list of PaymentAttempts. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_attempts.

Lua path: app.integrations.airwallex.retrieve_list_paymentattempts
Full name: airwallex.airwallex_online_payments_retrieve_list_of_paymentattempts

Parameter	Type	Required	Description
No parameters.

create_paymentconsent Write

Online Payments > Payment Consents > Create a PaymentConsent. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_consents/create.

Lua path: app.integrations.airwallex.create_paymentconsent
Full name: airwallex.airwallex_online_payments_create_a_paymentconsent

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_paymentconsent Write

Online Payments > Payment Consents > Update a PaymentConsent. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_consents/{payment_consent_id}/update.

Lua path: app.integrations.airwallex.update_paymentconsent
Full name: airwallex.airwallex_online_payments_update_a_paymentconsent

Parameter	Type	Required	Description
`payment_consent_id`	string	yes	Path parameter `payment_consent_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

disable_paymentconsent Write

Online Payments > Payment Consents > Disable a PaymentConsent. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_consents/{payment_consent_id}/disable.

Lua path: app.integrations.airwallex.disable_paymentconsent
Full name: airwallex.airwallex_online_payments_disable_a_paymentconsent

Parameter	Type	Required	Description
`payment_consent_id`	string	yes	Path parameter `payment_consent_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

verify_paymentconsent_card Write

Online Payments > Payment Consents > Verify a PaymentConsent - Card. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_consents/{id}/verify.

Lua path: app.integrations.airwallex.verify_paymentconsent_card
Full name: airwallex.airwallex_online_payments_verify_a_paymentconsent_card

Parameter	Type	Required	Description
`id`	string	yes	Path parameter `id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

continue_verify_paymentconsent Write

Online Payments > Payment Consents > Continue to Verify a PaymentConsent. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_consents/{payment_consent_id}/verify_continue.

Lua path: app.integrations.airwallex.continue_verify_paymentconsent
Full name: airwallex.airwallex_online_payments_continue_to_verify_a_paymentconsent

Parameter	Type	Required	Description
`payment_consent_id`	string	yes	Path parameter `payment_consent_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_paymentconsent Read

Online Payments > Payment Consents > Get a PaymentConsent. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_consents/{payment_consent_id}.

Lua path: app.integrations.airwallex.get_paymentconsent
Full name: airwallex.airwallex_online_payments_get_a_paymentconsent

Parameter	Type	Required	Description
`payment_consent_id`	string	yes	Path parameter `payment_consent_id`.

get_list_paymentconsents Read

Online Payments > Payment Consents > Get list of PaymentConsents. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_consents.

Lua path: app.integrations.airwallex.get_list_paymentconsents
Full name: airwallex.airwallex_online_payments_get_list_of_paymentconsents

Parameter	Type	Required	Description
No parameters.

create_paymentintent_mvp Write

Online Payments > Payment Intents > Create a PaymentIntent - MVP. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_intents/create.

Lua path: app.integrations.airwallex.create_paymentintent_mvp
Full name: airwallex.airwallex_online_payments_create_a_paymentintent_mvp

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_paymentintent Read

Online Payments > Payment Intents > Retrieve a PaymentIntent. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_intents/{payment_intent_id}.

Lua path: app.integrations.airwallex.retrieve_paymentintent
Full name: airwallex.airwallex_online_payments_retrieve_a_paymentintent

Parameter	Type	Required	Description
`payment_intent_id`	string	yes	Path parameter `payment_intent_id`.

confirm_paymentintent_payment_method_card Read

Online Payments > Payment Intents > Confirm a PaymentIntent - payment_method = card. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_intents/{payment_intent_id}/confirm.

Lua path: app.integrations.airwallex.confirm_paymentintent_payment_method_card
Full name: airwallex.airwallex_online_payments_confirm_a_paymentintent_payment_method_card

Parameter	Type	Required	Description
`payment_intent_id`	string	yes	Path parameter `payment_intent_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

continue_confirm_paymentintent Read

Online Payments > Payment Intents > Continue to confirm a PaymentIntent. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_intents/{payment_intent_id}/confirm_continue.

Lua path: app.integrations.airwallex.continue_confirm_paymentintent
Full name: airwallex.airwallex_online_payments_continue_to_confirm_a_paymentintent

Parameter	Type	Required	Description
`payment_intent_id`	string	yes	Path parameter `payment_intent_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

capture_paymentintent Read

Online Payments > Payment Intents > Capture a PaymentIntent. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_intents/{payment_intent_id}/capture.

Lua path: app.integrations.airwallex.capture_paymentintent
Full name: airwallex.airwallex_online_payments_capture_a_paymentintent

Parameter	Type	Required	Description
`payment_intent_id`	string	yes	Path parameter `payment_intent_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_paymentintents Read

Online Payments > Payment Intents > Get list of PaymentIntents. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_intents.

Lua path: app.integrations.airwallex.get_list_paymentintents
Full name: airwallex.airwallex_online_payments_get_list_of_paymentintents

Parameter	Type	Required	Description
No parameters.

create_paymentmethod Write

Online Payments > Payment Methods > Create a PaymentMethod. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_methods/create.

Lua path: app.integrations.airwallex.create_paymentmethod
Full name: airwallex.airwallex_online_payments_create_a_paymentmethod

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_paymentmethod Read

Online Payments > Payment Methods > Retrieve a PaymentMethod. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_methods/{payment_method_id}.

Lua path: app.integrations.airwallex.retrieve_paymentmethod
Full name: airwallex.airwallex_online_payments_retrieve_a_paymentmethod

Parameter	Type	Required	Description
`payment_method_id`	string	yes	Path parameter `payment_method_id`.

update_paymentmethod Write

Online Payments > Payment Methods > Update a PaymentMethod. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_methods/{payment_method_id}/update.

Lua path: app.integrations.airwallex.update_paymentmethod
Full name: airwallex.airwallex_online_payments_update_a_paymentmethod

Parameter	Type	Required	Description
`payment_method_id`	string	yes	Path parameter `payment_method_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_paymentmethods Read

Online Payments > Payment Methods > Get list of PaymentMethods. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/payment_methods.

Lua path: app.integrations.airwallex.get_list_paymentmethods
Full name: airwallex.airwallex_online_payments_get_list_of_paymentmethods

Parameter	Type	Required	Description
No parameters.

disable_paymentmethod Write

Online Payments > Payment Methods > Disable a PaymentMethod. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/payment_methods/{payment_method_id}/disable.

Lua path: app.integrations.airwallex.disable_paymentmethod
Full name: airwallex.airwallex_online_payments_disable_a_paymentmethod

Parameter	Type	Required	Description
`payment_method_id`	string	yes	Path parameter `payment_method_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_refund Write

Online Payments > Refunds > Create a Refund. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/pa/refunds/create.

Lua path: app.integrations.airwallex.create_refund
Full name: airwallex.airwallex_online_payments_create_a_refund

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_refund Read

Online Payments > Refunds > Retrieve a Refund. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/refunds/{refund_id}.

Lua path: app.integrations.airwallex.retrieve_refund
Full name: airwallex.airwallex_online_payments_retrieve_a_refund

Parameter	Type	Required	Description
`refund_id`	string	yes	Path parameter `refund_id`.

get_list_refunds Read

Online Payments > Refunds > Get list of Refunds. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/refunds.

Lua path: app.integrations.airwallex.get_list_refunds
Full name: airwallex.airwallex_online_payments_get_list_of_refunds

Parameter	Type	Required	Description
No parameters.

get_list_beneficiaries Read

Payouts > Beneficiaries > Get list of beneficiaries. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/beneficiaries.

Lua path: app.integrations.airwallex.get_list_beneficiaries
Full name: airwallex.airwallex_payouts_get_list_of_beneficiaries

Parameter	Type	Required	Description
No parameters.

get_beneficiary_by_id Read

Payouts > Beneficiaries > Get a beneficiary by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/beneficiaries/{beneficiary_id}.

Lua path: app.integrations.airwallex.get_beneficiary_by_id
Full name: airwallex.airwallex_payouts_get_a_beneficiary_by_id

Parameter	Type	Required	Description
`beneficiary_id`	string	yes	Path parameter `beneficiary_id`.

create_new_beneficiary Write

Payouts > Beneficiaries > Create a new beneficiary. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/beneficiaries/create.

Lua path: app.integrations.airwallex.create_new_beneficiary
Full name: airwallex.airwallex_payouts_create_a_new_beneficiary

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_existing_beneficiary Write

Payouts > Beneficiaries > Update existing beneficiary. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/beneficiaries/{beneficiary_id}/update.

Lua path: app.integrations.airwallex.update_existing_beneficiary
Full name: airwallex.airwallex_payouts_update_existing_beneficiary

Parameter	Type	Required	Description
`beneficiary_id`	string	yes	Path parameter `beneficiary_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

validate_beneficiary Read

Payouts > Beneficiaries > Validate beneficiary. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/beneficiaries/validate.

Lua path: app.integrations.airwallex.validate_beneficiary
Full name: airwallex.airwallex_payouts_validate_beneficiary

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

delete_existing_beneficiary Write

Payouts > Beneficiaries > Delete existing beneficiary. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/beneficiaries/{id}/delete.

Lua path: app.integrations.airwallex.delete_existing_beneficiary
Full name: airwallex.airwallex_payouts_delete_existing_beneficiary

Parameter	Type	Required	Description
`id`	string	yes	Path parameter `id`.

get_api_schema Read

Payouts > Beneficiaries > Get the API schema. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/beneficiary_api_schemas/generate.

Lua path: app.integrations.airwallex.get_api_schema
Full name: airwallex.airwallex_payouts_get_the_api_schema

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_form_schema Read

Payouts > Beneficiaries > Get the form schema. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/beneficiary_form_schemas/generate.

Lua path: app.integrations.airwallex.get_form_schema
Full name: airwallex.airwallex_payouts_get_the_form_schema

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_payers Read

Payouts > Payers > Get list of payers. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/payers.

Lua path: app.integrations.airwallex.get_list_payers
Full name: airwallex.airwallex_payouts_get_list_of_payers

Parameter	Type	Required	Description
No parameters.

create_new_payer Write

Payouts > Payers > Create a new payer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/payers/create.

Lua path: app.integrations.airwallex.create_new_payer
Full name: airwallex.airwallex_payouts_create_a_new_payer

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_payer_by_id Read

Payouts > Payers > Get a payer by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/payers/{payer_id}.

Lua path: app.integrations.airwallex.get_payer_by_id
Full name: airwallex.airwallex_payouts_get_a_payer_by_id

Parameter	Type	Required	Description
`payer_id`	string	yes	Path parameter `payer_id`.

update_existing_payer Write

Payouts > Payers > Update existing payer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/payers/{payer_id}/update.

Lua path: app.integrations.airwallex.update_existing_payer
Full name: airwallex.airwallex_payouts_update_existing_payer

Parameter	Type	Required	Description
`payer_id`	string	yes	Path parameter `payer_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

validate_payer Read

Payouts > Payers > Validate payer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/payers/validate.

Lua path: app.integrations.airwallex.validate_payer
Full name: airwallex.airwallex_payouts_validate_payer

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

delete_existing_payer Write

Payouts > Payers > Delete existing payer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/payers/{payer_id}/delete.

Lua path: app.integrations.airwallex.delete_existing_payer
Full name: airwallex.airwallex_payouts_delete_existing_payer

Parameter	Type	Required	Description
`payer_id`	string	yes	Path parameter `payer_id`.

create_new_transfer_beneficiary Write

Payouts > Transfers > Create a new transfer - to beneficiary. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/transfers/create.

Lua path: app.integrations.airwallex.create_new_transfer_beneficiary
Full name: airwallex.airwallex_payouts_create_a_new_transfer_to_beneficiary

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_transfers Read

Payouts > Transfers > Get list of transfers. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/transfers.

Lua path: app.integrations.airwallex.get_list_transfers
Full name: airwallex.airwallex_payouts_get_list_of_transfers

Parameter	Type	Required	Description
No parameters.

get_transfer_by_id Read

Payouts > Transfers > Get transfer by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/transfers/{transfer_id}.

Lua path: app.integrations.airwallex.get_transfer_by_id
Full name: airwallex.airwallex_payouts_get_transfer_by_id

Parameter	Type	Required	Description
`transfer_id`	string	yes	Path parameter `transfer_id`.

validate_transfer Read

Payouts > Transfers > Validate transfer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/transfers/validate.

Lua path: app.integrations.airwallex.validate_transfer
Full name: airwallex.airwallex_payouts_validate_transfer

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

cancel_transfer Write

Payouts > Transfers > Cancel a transfer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/transfers/{transfer_id}/cancel.

Lua path: app.integrations.airwallex.cancel_transfer
Full name: airwallex.airwallex_payouts_cancel_a_transfer

Parameter	Type	Required	Description
`transfer_id`	string	yes	Path parameter `transfer_id`.

create_financial_report Write

Reporting > Financial Reports > Create a financial report. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/finance/financial_reports/create.

Lua path: app.integrations.airwallex.create_financial_report
Full name: airwallex.airwallex_reporting_create_a_financial_report

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_financial_reports Read

Reporting > Financial Reports > Get list of financial reports. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/finance/financial_reports.

Lua path: app.integrations.airwallex.get_list_financial_reports
Full name: airwallex.airwallex_reporting_get_list_of_financial_reports

Parameter	Type	Required	Description
No parameters.

get_financial_report_by_id Read

Reporting > Financial Reports > Get financial report by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/finance/financial_reports/{report_id}.

Lua path: app.integrations.airwallex.get_financial_report_by_id
Full name: airwallex.airwallex_reporting_get_financial_report_by_id

Parameter	Type	Required	Description
`report_id`	string	yes	Path parameter `report_id`.

get_contents_financial_report Read

Reporting > Financial Reports > Get contents of a financial report. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/finance/financial_reports/{report_id}/content.

Lua path: app.integrations.airwallex.get_contents_financial_report
Full name: airwallex.airwallex_reporting_get_contents_of_a_financial_report

Parameter	Type	Required	Description
`report_id`	string	yes	Path parameter `report_id`.

get_list_financial_transactions Read

Reporting > Financial Transactions > Get list of financial transactions. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/financial_transactions.

Lua path: app.integrations.airwallex.get_list_financial_transactions
Full name: airwallex.airwallex_reporting_get_list_of_financial_transactions

Parameter	Type	Required	Description
`page_size`	string	no	Number of results per page, default is 100, max is 1000
`to_created_at`	string	no	The end time of created_at in ISO8601 format (inclusive)

get_financial_transaction_by_id Read

Reporting > Financial Transactions > Get a financial transaction by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/financial_transactions/{financial_transaction_id}.

Lua path: app.integrations.airwallex.get_financial_transaction_by_id
Full name: airwallex.airwallex_reporting_get_a_financial_transaction_by_id

Parameter	Type	Required	Description
`financial_transaction_id`	string	yes	Path parameter `financial_transaction_id`.

get_list_settlements Read

Reporting > Settlements > Get list of settlements. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/financial/settlements.

Lua path: app.integrations.airwallex.get_list_settlements
Full name: airwallex.airwallex_reporting_get_list_of_settlements

Parameter	Type	Required	Description
No parameters.

get_settlement_by_id Read

Reporting > Settlements > Get a settlement by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/financial/settlements/{settlement_id}.

Lua path: app.integrations.airwallex.get_settlement_by_id
Full name: airwallex.airwallex_reporting_get_a_settlement_by_id

Parameter	Type	Required	Description
`settlement_id`	string	yes	Path parameter `settlement_id`.

get_settlement_report_by_id Read

Reporting > Settlements > Get a settlement report by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/pa/financial/settlements/{settlement_id}/report.

Lua path: app.integrations.airwallex.get_settlement_report_by_id
Full name: airwallex.airwallex_reporting_get_a_settlement_report_by_id

Parameter	Type	Required	Description
`settlement_id`	string	yes	Path parameter `settlement_id`.

create_account_invitation_link_oauth2 Write

Scale > Account Links > Create an account invitation link - oauth2. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/accounts/invitation_links/create.

Lua path: app.integrations.airwallex.create_account_invitation_link_oauth2
Full name: airwallex.airwallex_scale_create_an_account_invitation_link_oauth2

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_account_invitation_link_by_id Read

Scale > Account Links > Get an account invitation link by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/accounts/invitation_links/{invitation_link_id}.

Lua path: app.integrations.airwallex.get_account_invitation_link_by_id
Full name: airwallex.airwallex_scale_get_an_account_invitation_link_by_id

Parameter	Type	Required	Description
`invitation_link_id`	string	yes	Path parameter `invitation_link_id`.

create_account_business Write

Scale > Accounts > Create an account - Business. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/accounts/create.

Lua path: app.integrations.airwallex.create_account_business
Full name: airwallex.airwallex_scale_create_an_account_business

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

update_connected_account Write

Scale > Accounts > Update a connected account. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/accounts/{connected_account_id}/update.

Lua path: app.integrations.airwallex.update_connected_account
Full name: airwallex.airwallex_scale_update_a_connected_account

Parameter	Type	Required	Description
`connected_account_id`	string	yes	Path parameter `connected_account_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

submit_account_activation Write

Scale > Accounts > Submit account for activation. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/accounts/{connected_account_id}/submit.

Lua path: app.integrations.airwallex.submit_account_activation
Full name: airwallex.airwallex_scale_submit_account_for_activation

Parameter	Type	Required	Description
`connected_account_id`	string	yes	Path parameter `connected_account_id`.

agree_terms_and_conditions Read

Scale > Accounts > Agree to terms and conditions. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/accounts/{connected_account_id}/terms_and_conditions/agree.

Lua path: app.integrations.airwallex.agree_terms_and_conditions
Full name: airwallex.airwallex_scale_agree_to_terms_and_conditions

Parameter	Type	Required	Description
`connected_account_id`	string	yes	Path parameter `connected_account_id`.

get_account_by_id Read

Scale > Accounts > Get account by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/accounts/{connected_account_id}.

Lua path: app.integrations.airwallex.get_account_by_id
Full name: airwallex.airwallex_scale_get_account_by_id

Parameter	Type	Required	Description
`connected_account_id`	string	yes	Path parameter `connected_account_id`.

get_list_connected_accounts Read

Scale > Accounts > Get list of connected accounts. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/accounts.

Lua path: app.integrations.airwallex.get_list_connected_accounts
Full name: airwallex.airwallex_scale_get_list_of_connected_accounts

Parameter	Type	Required	Description
No parameters.

retrieve_account_details Read

Scale > Accounts > Retrieve account details. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/account.

Lua path: app.integrations.airwallex.retrieve_account_details
Full name: airwallex.airwallex_scale_retrieve_account_details

Parameter	Type	Required	Description
No parameters.

create_new_charge Write

Scale > Charges > Create a new charge. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/charges/create.

Lua path: app.integrations.airwallex.create_new_charge
Full name: airwallex.airwallex_scale_create_a_new_charge

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_charges Read

Scale > Charges > Get list of charges. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/charges.

Lua path: app.integrations.airwallex.get_list_charges
Full name: airwallex.airwallex_scale_get_list_of_charges

Parameter	Type	Required	Description
No parameters.

get_charge_by_id Read

Scale > Charges > Get a charge by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/charges/{charge_id}.

Lua path: app.integrations.airwallex.get_charge_by_id
Full name: airwallex.airwallex_scale_get_a_charge_by_id

Parameter	Type	Required	Description
`charge_id`	string	yes	Path parameter `charge_id`.

create_flow Write

Scale > Hosted Flow > Create flow. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/hosted_flows/create.

Lua path: app.integrations.airwallex.create_flow
Full name: airwallex.airwallex_scale_create_flow

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_flow Read

Scale > Hosted Flow > Get flow. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/hosted_flows/{hosted_flow_instance_id}.

Lua path: app.integrations.airwallex.get_flow
Full name: airwallex.airwallex_scale_get_flow

Parameter	Type	Required	Description
`hosted_flow_instance_id`	string	yes	Path parameter `hosted_flow_instance_id`.

authorize_flow Read

Scale > Hosted Flow > Authorize flow. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/hosted_flows/{hosted_flow_instance_id}/authorize.

Lua path: app.integrations.airwallex.authorize_flow
Full name: airwallex.airwallex_scale_authorize_flow

Parameter	Type	Required	Description
`hosted_flow_instance_id`	string	yes	Path parameter `hosted_flow_instance_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_new_connected_account_transfer Write

Scale > Connected Account Transfers > Create a new connected account transfer. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/connected_account_transfers/create.

Lua path: app.integrations.airwallex.create_new_connected_account_transfer
Full name: airwallex.airwallex_scale_create_a_new_connected_account_transfer

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_connected_account_transfers Read

Scale > Connected Account Transfers > Get list of connected account transfers. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/connected_account_transfers.

Lua path: app.integrations.airwallex.get_list_connected_account_transfers
Full name: airwallex.airwallex_scale_get_list_of_connected_account_transfers

Parameter	Type	Required	Description
No parameters.

get_connected_account_transfer_by_id Read

Scale > Connected Account Transfers > Get a connected account transfer by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/connected_account_transfers/{transfer_id}.

Lua path: app.integrations.airwallex.get_connected_account_transfer_by_id
Full name: airwallex.airwallex_scale_get_a_connected_account_transfer_by_id

Parameter	Type	Required	Description
`transfer_id`	string	yes	Path parameter `transfer_id`.

update_status_connected_account Write

Simulation (Demo Only) > Accounts > Update status of connected account. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/accounts/{account_id}/update_status.

Lua path: app.integrations.airwallex.update_status_connected_account
Full name: airwallex.airwallex_simulation_demo_only_update_status_of_connected_account

Parameter	Type	Required	Description
`account_id`	string	yes	Path parameter `account_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

fail_next_autocharge Read

Simulation (Demo Only) > Billing > Fail next autocharge. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/billing/payment_sources/{payment_source_id}/fail_next_autocharge.

Lua path: app.integrations.airwallex.fail_next_autocharge
Full name: airwallex.airwallex_simulation_demo_only_fail_next_autocharge

Parameter	Type	Required	Description
`payment_source_id`	string	yes	Path parameter `payment_source_id`.

create_global_account_deposit Write

Simulation (Demo Only) > Deposits > Create a global account deposit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/deposit/create.

Lua path: app.integrations.airwallex.create_global_account_deposit
Full name: airwallex.airwallex_simulation_demo_only_create_a_global_account_deposit

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

reject_direct_debit_deposit Read

Simulation (Demo Only) > Deposits > Reject a direct debit deposit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/deposits/{deposit_id}/reject.

Lua path: app.integrations.airwallex.reject_direct_debit_deposit
Full name: airwallex.airwallex_simulation_demo_only_reject_a_direct_debit_deposit

Parameter	Type	Required	Description
`deposit_id`	string	yes	Path parameter `deposit_id`.

reverse_direct_debit_deposit Read

Simulation (Demo Only) > Deposits > Reverse a direct debit deposit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/deposits/{deposit_id}/reverse.

Lua path: app.integrations.airwallex.reverse_direct_debit_deposit
Full name: airwallex.airwallex_simulation_demo_only_reverse_a_direct_debit_deposit

Parameter	Type	Required	Description
`deposit_id`	string	yes	Path parameter `deposit_id`.

settle_direct_debit_deposit Read

Simulation (Demo Only) > Deposits > Settle a direct debit deposit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/deposits/{deposit_id}/settle.

Lua path: app.integrations.airwallex.settle_direct_debit_deposit
Full name: airwallex.airwallex_simulation_demo_only_settle_a_direct_debit_deposit

Parameter	Type	Required	Description
`deposit_id`	string	yes	Path parameter `deposit_id`.

create_transaction_provided_card Write

Simulation (Demo Only) > Issuing > Create a transaction for the provided card. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/issuing/create.

Lua path: app.integrations.airwallex.create_transaction_provided_card
Full name: airwallex.airwallex_simulation_demo_only_create_a_transaction_for_the_provided_card

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

capture_transaction_with_provided_id Read

Simulation (Demo Only) > Issuing > Capture the transaction with the provided id. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/issuing/{transaction_id}/capture.

Lua path: app.integrations.airwallex.capture_transaction_with_provided_id
Full name: airwallex.airwallex_simulation_demo_only_capture_the_transaction_with_the_provided_id

Parameter	Type	Required	Description
`transaction_id`	string	yes	Path parameter `transaction_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

accept_mandate Read

Simulation (Demo Only) > Linked Accounts > Accept a Mandate. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/accept.

Lua path: app.integrations.airwallex.accept_mandate
Full name: airwallex.airwallex_simulation_demo_only_accept_a_mandate

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.

reject_mandate Read

Simulation (Demo Only) > Linked Accounts > Reject a Mandate. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/reject.

Lua path: app.integrations.airwallex.reject_mandate
Full name: airwallex.airwallex_simulation_demo_only_reject_a_mandate

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.

cancel_mandate Write

Simulation (Demo Only) > Linked Accounts > Cancel a Mandate. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/cancel.

Lua path: app.integrations.airwallex.cancel_mandate
Full name: airwallex.airwallex_simulation_demo_only_cancel_a_mandate

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.

fail_micro_deposits_verification Read

Simulation (Demo Only) > Linked Accounts > Fail a Micro Deposits verification. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/linked_accounts/{linked_account_id}/fail_microdeposits.

Lua path: app.integrations.airwallex.fail_micro_deposits_verification
Full name: airwallex.airwallex_simulation_demo_only_fail_a_micro_deposits_verification

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.

create_paymentdispute Write

Simulation (Demo Only) > Payment Acceptance > Create a PaymentDispute. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/pa/payment_disputes/create.

Lua path: app.integrations.airwallex.create_paymentdispute
Full name: airwallex.airwallex_simulation_demo_only_create_a_paymentdispute

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

resolve_paymentdispute Read

Simulation (Demo Only) > Payment Acceptance > Resolve a PaymentDispute. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/pa/payment_disputes/{dispute_id}/resolve.

Lua path: app.integrations.airwallex.resolve_paymentdispute
Full name: airwallex.airwallex_simulation_demo_only_resolve_a_paymentdispute

Parameter	Type	Required	Description
`dispute_id`	string	yes	Path parameter `dispute_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

escalate_paymentdispute Read

Simulation (Demo Only) > Payment Acceptance > Escalate a PaymentDispute. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/pa/payment_disputes/{dispute_id}/escalate.

Lua path: app.integrations.airwallex.escalate_paymentdispute
Full name: airwallex.airwallex_simulation_demo_only_escalate_a_paymentdispute

Parameter	Type	Required	Description
`dispute_id`	string	yes	Path parameter `dispute_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

simulate_shopper_action Read

Simulation (Demo Only) > Payment Acceptance > Simulate a shopper action. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/pa/shopper_actions/{action}.

Lua path: app.integrations.airwallex.simulate_shopper_action
Full name: airwallex.airwallex_simulation_demo_only_simulate_a_shopper_action

Parameter	Type	Required	Description
`action`	string	yes	Path parameter `action`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

transition_payment_status Read

Simulation (Demo Only) > Payouts > Transition Payment Status. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/payments/{id}/transition.

Lua path: app.integrations.airwallex.transition_payment_status
Full name: airwallex.airwallex_simulation_demo_only_transition_payment_status

Parameter	Type	Required	Description
`id`	string	yes	Path parameter `id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_rfi Write

Simulation (Demo Only) > Request for Information (RFI) > Create an RFI. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/rfis/create.

Lua path: app.integrations.airwallex.create_rfi
Full name: airwallex.airwallex_simulation_demo_only_create_an_rfi

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

follow_up_rfi Read

Simulation (Demo Only) > Request for Information (RFI) > Follow-up RFI. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/rfis/{rfi_id}/follow_up.

Lua path: app.integrations.airwallex.follow_up_rfi
Full name: airwallex.airwallex_simulation_demo_only_follow_up_rfi

Parameter	Type	Required	Description
`rfi_id`	string	yes	Path parameter `rfi_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

close_rfi Read

Simulation (Demo Only) > Request for Information (RFI) > Close an RFI. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/rfis/{rfi_id}/close.

Lua path: app.integrations.airwallex.close_rfi
Full name: airwallex.airwallex_simulation_demo_only_close_an_rfi

Parameter	Type	Required	Description
`rfi_id`	string	yes	Path parameter `rfi_id`.

transition_transfer_status Read

Simulation (Demo Only) > Transfers > Transition Transfer Status. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/simulation/transfers/{transfer_id}/transition.

Lua path: app.integrations.airwallex.transition_transfer_status
Full name: airwallex.airwallex_simulation_demo_only_transition_transfer_status

Parameter	Type	Required	Description
`transfer_id`	string	yes	Path parameter `transfer_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

upload_file Read

Supporting Services > File Service > Upload a file. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/files/upload.

Lua path: app.integrations.airwallex.upload_file
Full name: airwallex.airwallex_supporting_services_upload_a_file

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_onboarding_file_download_links Read

Supporting Services > File Service > Get onboarding file download links. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/files/download_links.

Lua path: app.integrations.airwallex.get_onboarding_file_download_links
Full name: airwallex.airwallex_supporting_services_get_onboarding_file_download_links

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

industry_categories Read

Supporting Services > Reference Data > Industry categories. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/reference/industry_categories.

Lua path: app.integrations.airwallex.industry_categories
Full name: airwallex.airwallex_supporting_services_industry_categories

Parameter	Type	Required	Description
No parameters.

invalid_conversion_dates Read

Supporting Services > Reference Data > Invalid conversion dates. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/reference/invalid_conversion_dates.

Lua path: app.integrations.airwallex.invalid_conversion_dates
Full name: airwallex.airwallex_supporting_services_invalid_conversion_dates

Parameter	Type	Required	Description
`currency_pair`	string	no	Currency pair to get the invalid conversion dates for

settlement_accounts Read

Supporting Services > Reference Data > Settlement accounts. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/reference/settlement_accounts.

Lua path: app.integrations.airwallex.settlement_accounts
Full name: airwallex.airwallex_supporting_services_settlement_accounts

Parameter	Type	Required	Description
No parameters.

supported_currencies Read

Supporting Services > Reference Data > Supported currencies. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/reference/supported_currencies.

Lua path: app.integrations.airwallex.supported_currencies
Full name: airwallex.airwallex_supporting_services_supported_currencies

Parameter	Type	Required	Description
No parameters.

create_quote Write

Transactional FX > Quotes > Create a quote. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/fx/quotes/create.

Lua path: app.integrations.airwallex.create_quote
Full name: airwallex.airwallex_transactional_fx_create_a_quote

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

create_conversion_buy_amount_based Write

Transactional FX > Conversion > Create a conversion - buy_amount based. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/fx/conversions/create.

Lua path: app.integrations.airwallex.create_conversion_buy_amount_based
Full name: airwallex.airwallex_transactional_fx_create_a_conversion_buy_amount_based

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_specific_conversion Read

Transactional FX > Conversion > Retrieve a specific conversion. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/fx/conversions/{conversion_id}.

Lua path: app.integrations.airwallex.retrieve_specific_conversion
Full name: airwallex.airwallex_transactional_fx_retrieve_a_specific_conversion

Parameter	Type	Required	Description
`conversion_id`	string	yes	Path parameter `conversion_id`.

list_conversions Read

Transactional FX > Conversion > List conversions. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/fx/conversions.

Lua path: app.integrations.airwallex.list_conversions
Full name: airwallex.airwallex_transactional_fx_list_conversions

Parameter	Type	Required	Description
No parameters.

create_amendment_quote Write

Transactional FX > Conversion Amendments > Create an amendment quote. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/fx/conversion_amendments/quote.

Lua path: app.integrations.airwallex.create_amendment_quote
Full name: airwallex.airwallex_transactional_fx_create_an_amendment_quote

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

retrieve_current_rate Read

Transactional FX > Rates > Retrieve a current rate. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/fx/rates/current.

Lua path: app.integrations.airwallex.retrieve_current_rate
Full name: airwallex.airwallex_transactional_fx_retrieve_a_current_rate

Parameter	Type	Required	Description
`buy_currency`	string	no	Currency (3-letter ISO-4217 code) the client buys
`sell_currency`	string	no	Currency (3-letter ISO-4217 code) the client sells. This is the currency you will need to send us by the settlement cutoff time
`buy_amount`	string	no	Amount the client buys in buy_currency (must be blank if sell_amount is specified)

get_current_balances Read

Treasury > Balances > Get current balances. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/balances/current.

Lua path: app.integrations.airwallex.get_current_balances
Full name: airwallex.airwallex_treasury_get_current_balances

Parameter	Type	Required	Description
No parameters.

get_balance_history Read

Treasury > Balances > Get balance history. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/balances/history.

Lua path: app.integrations.airwallex.get_balance_history
Full name: airwallex.airwallex_treasury_get_balance_history

Parameter	Type	Required	Description
No parameters.

get_list_deposits Read

Treasury > Deposits > Get list of deposits. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/deposits.

Lua path: app.integrations.airwallex.get_list_deposits
Full name: airwallex.airwallex_treasury_get_list_of_deposits

Parameter	Type	Required	Description
No parameters.

get_deposit_by_id Read

Treasury > Deposits > Get a deposit by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/deposits/{deposit_id}.

Lua path: app.integrations.airwallex.get_deposit_by_id
Full name: airwallex.airwallex_treasury_get_a_deposit_by_id

Parameter	Type	Required	Description
`deposit_id`	string	yes	Path parameter `deposit_id`.

create_deposit_via_direct_debit Write

Treasury > Deposits > Create a deposit via Direct Debit. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/deposits/create.

Lua path: app.integrations.airwallex.create_deposit_via_direct_debit
Full name: airwallex.airwallex_treasury_create_a_deposit_via_direct_debit

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

open_global_account Read

Treasury > Global Accounts > Open a global account. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/global_accounts/create.

Lua path: app.integrations.airwallex.open_global_account
Full name: airwallex.airwallex_treasury_open_a_global_account

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

generate_global_account_statement_amazon Read

Treasury > Global Accounts > Generate global account statement - AMAZON. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/global_accounts/{global_account_id}/generate_statement_letter.

Lua path: app.integrations.airwallex.generate_global_account_statement_amazon
Full name: airwallex.airwallex_treasury_generate_global_account_statement_amazon

Parameter	Type	Required	Description
`global_account_id`	string	yes	Path parameter `global_account_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_list_global_accounts Read

Treasury > Global Accounts > Get a list of global accounts. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/global_accounts.

Lua path: app.integrations.airwallex.get_list_global_accounts
Full name: airwallex.airwallex_treasury_get_a_list_of_global_accounts

Parameter	Type	Required	Description
No parameters.

get_global_account_by_id Read

Treasury > Global Accounts > Get global account by ID. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/global_accounts/{global_account_id}.

Lua path: app.integrations.airwallex.get_global_account_by_id
Full name: airwallex.airwallex_treasury_get_global_account_by_id

Parameter	Type	Required	Description
`global_account_id`	string	yes	Path parameter `global_account_id`.

get_global_account_transactions Read

Treasury > Global Accounts > Get global account transactions. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/global_accounts/{global_account_id}/transactions.

Lua path: app.integrations.airwallex.get_global_account_transactions
Full name: airwallex.airwallex_treasury_get_global_account_transactions

Parameter	Type	Required	Description
`global_account_id`	string	yes	Path parameter `global_account_id`.

create_linked_bank_account Write

Treasury > Direct Debit LBA > Create Linked Bank Account. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/linked_accounts/create.

Lua path: app.integrations.airwallex.create_linked_bank_account
Full name: airwallex.airwallex_treasury_create_linked_bank_account

Parameter	Type	Required	Description
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

verify_linked_account_with_micro_deposits Write

Treasury > Direct Debit LBA > Verify Linked Account with micro-deposits. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/linked_accounts/{linked_account_id}/verify_microdeposits.

Lua path: app.integrations.airwallex.verify_linked_account_with_micro_deposits
Full name: airwallex.airwallex_treasury_verify_linked_account_with_micro_deposits

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_linked_bank_accounts Read

Treasury > Direct Debit LBA > Get Linked Bank Accounts. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/linked_accounts.

Lua path: app.integrations.airwallex.get_linked_bank_accounts
Full name: airwallex.airwallex_treasury_get_linked_bank_accounts

Parameter	Type	Required	Description
No parameters.

get_linked_bank_account_by_id Read

Treasury > Direct Debit LBA > Get Linked Bank Account by id. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/linked_accounts/{linked_account_id}.

Lua path: app.integrations.airwallex.get_linked_bank_account_by_id
Full name: airwallex.airwallex_treasury_get_linked_bank_account_by_id

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.

update_mandate_lba Write

Treasury > Direct Debit LBA > Update Mandate for LBA. Maps to the official Airwallex public Postman collection endpoint POST /api/v1/linked_accounts/{linked_account_id}/mandate.

Lua path: app.integrations.airwallex.update_mandate_lba
Full name: airwallex.airwallex_treasury_update_mandate_for_lba

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.
`body`	object	yes	Request body fields matching the Airwallex API request example for this endpoint.

get_mandate Read

Treasury > Direct Debit LBA > Get mandate. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/linked_accounts/{linked_account_id}/mandate.

Lua path: app.integrations.airwallex.get_mandate
Full name: airwallex.airwallex_treasury_get_mandate

Parameter	Type	Required	Description
`linked_account_id`	string	yes	Path parameter `linked_account_id`.

funding_limits Read

Treasury > Direct Debit LBA > Funding limits. Maps to the official Airwallex public Postman collection endpoint GET /api/v1/account_capabilities/funding_limits.

Lua path: app.integrations.airwallex.funding_limits
Full name: airwallex.airwallex_treasury_funding_limits

Parameter	Type	Required	Description
No parameters.