Airwallex logo

Developer MCP

Empower AI coding agents with the tools they need to accelerate Airwallex API integrations

Copy for LLMView as Markdown

The Airwallex Developer Model Context Protocol (MCP) server enables coding agents to search Airwallex documentation and interact with the sandbox environment for testing and simulation.

Two remote endpoints are available:

  • https://mcp-demo.airwallex.com/developer: Provides access to documentation and sandbox tools. Requires OAuth authentication.
  • https://mcp-demo.airwallex.com/docs: Provides documentation-only access without authentication.

A local server (npx @airwallex/developer-mcp@latest) runs on your machine via Node.js and provides full tool access, including billing tools, without OAuth. Authenticate using your sandbox API credentials.

Remote endpoints work seamlessly with both desktop and web-based AI assistants. Note that we do not currently support Billing tools on our developer MCP server.

Before you begin

Before you connect your coding assistant to the Developer MCP server, ensure you have:

  • A compatible AI coding assistant installed (Cursor, Claude Code, or other MCP-compatible tool).
  • A sandbox account if you want to use the remote /developer endpoint or the local server.
  • Sandbox API credentials (Client ID and API Key) if you want to use the local server.
  • Node.js version 18.x or later installed and available on your PATH if you want to use the local server.

Connect your AI assistant

Cursor

You can use one-click installation links or manual configuration.

Documentation and sandbox tools at /developer. Cursor initiates OAuth to authenticate with Airwallex.

Install Airwallex Developer MCP in Cursor

Or manually add to your Cursor MCP settings:

JSON
1{
2 "mcpServers": {
3 "airwallex-dev": {
4 "type": "http",
5 "url": "https://mcp-demo.airwallex.com/developer"
6 }
7 }
8}

consent-page

oauth-login-page

oauth-scopes-page

Documentation-only access at /docs, without authentication.

Install Airwallex Developer MCP in Cursor

Or manually add to your Cursor MCP settings:

JSON
1{
2 "mcpServers": {
3 "airwallex-docs": {
4 "type": "http",
5 "url": "https://mcp-demo.airwallex.com/docs"
6 }
7 }
8}

Full tool access including billing tools, without OAuth.

Install Airwallex Developer MCP in Cursor

Or manually add the following to your Cursor MCP settings and fill in your sandbox credentials:

JSON
1{
2 "mcpServers": {
3 "airwallex-dev": {
4 "command": "npx",
5 "args": ["-y", "@airwallex/developer-mcp@latest"],
6 "env": {
7 "AIRWALLEX_SANDBOX_CLIENT_ID": "",
8 "AIRWALLEX_SANDBOX_API_KEY": "",
9 "AIRWALLEX_SANDBOX_ACCOUNT_ID": ""
10 }
11 }
12 }
13}

Claude Code

Documentation and sandbox tools at /developer. Claude Code initiates OAuth to authenticate with Airwallex.

Shell
1claude mcp add-json airwallex-dev '{ "type": "http", "url": "https://mcp-demo.airwallex.com/developer" }'

Documentation-only access at /docs, without authentication.

Shell
1claude mcp add-json airwallex-docs '{ "type": "http", "url": "https://mcp-demo.airwallex.com/docs" }'

Full tool access including billing tools, without OAuth. Run the following command and fill in your sandbox credentials:

Shell
1claude mcp add-json airwallex-dev '{ "type": "stdio", "command":"npx", "args": ["-y", "@airwallex/developer-mcp@latest"], "env": { "AIRWALLEX_SANDBOX_CLIENT_ID": "", "AIRWALLEX_SANDBOX_API_KEY": "", "AIRWALLEX_SANDBOX_ACCOUNT_ID": "" } }'

Claude.ai/Claude Desktop

Find the official Airwallex Developer connector from Settings > Connectors.

Developer MCP Claude Web Connector Search

Developer MCP Claude Web Connector Detail

When you try to connect, Claude will initiate an OAuth flow to authenticate with Airwallex.

Add custom connector for documentation-only MCP (/docs) without authentication. From Settings > Connectors > Add custom connector, use https://mcp-demo.airwallex.com/docs as the Remote MCP server URL.

Developer MCP Claude Web Custom Connector

Gemini CLI

Add the following configuration to your Gemini CLI MCP settings for /developer. Gemini CLI initiates OAuth to authenticate with Airwallex.

JSON
1{
2 "mcpServers": {
3 "airwallex-dev": {
4 "type": "http",
5 "url": "https://mcp-demo.airwallex.com/developer"
6 }
7 }
8}

Add the following configuration to your Gemini CLI MCP settings for documentation-only access at /docs (no authentication):

JSON
1{
2 "mcpServers": {
3 "airwallex-docs": {
4 "type": "http",
5 "url": "https://mcp-demo.airwallex.com/docs"
6 }
7 }
8}

Full tool access including billing tools, without OAuth. Add the following to your Gemini CLI MCP settings and fill in your sandbox credentials:

JSON
1{
2 "mcpServers": {
3 "airwallex-dev": {
4 "command": "npx",
5 "args": ["-y", "@airwallex/developer-mcp@latest"],
6 "timeout": 30000,
7 "env": {
8 "AIRWALLEX_SANDBOX_CLIENT_ID": "",
9 "AIRWALLEX_SANDBOX_API_KEY": "",
10 "AIRWALLEX_SANDBOX_ACCOUNT_ID": ""
11 }
12 }
13 }
14}

OpenAI Codex

Add the following to your OpenAI Codex MCP settings for /developer. Codex initiates OAuth to authenticate with Airwallex.

toml
1[mcp_servers.airwallex-dev]
2type = "http"
3url = "https://mcp-demo.airwallex.com/developer"

Add the following to your OpenAI Codex MCP settings for documentation-only access at /docs (no authentication):

toml
1[mcp_servers.airwallex-docs]
2type = "http"
3url = "https://mcp-demo.airwallex.com/docs"

Full tool access including billing tools, without OAuth. Add the following to your OpenAI Codex MCP settings and fill in your sandbox credentials:

toml
1[mcp_servers.airwallex-dev]
2command = "npx"
3args = ["-y", "@airwallex/developer-mcp@latest"]
4
5[mcp_servers.airwallex-dev.env]
6AIRWALLEX_SANDBOX_CLIENT_ID = ""
7AIRWALLEX_SANDBOX_API_KEY = ""
8AIRWALLEX_SANDBOX_ACCOUNT_ID = ""

Lovable

Lovable is a web-based coding agent that only supports remote MCP servers. MCP server support requires a paid plan.

Documentation and sandbox tools at /developer. Lovable initiates OAuth to authenticate with Airwallex.

Lovable OAuth Flow

Documentation-only access at /docs.

Lovable MCP Configuration

V0

V0 by Vercel is a web-based AI coding agent that only supports remote MCP servers. MCP server support requires a paid plan.

V0 does not support the /developer endpoint today. Use the Docs tab for the documentation-only server, or another coding agent if you need sandbox tools.

Documentation-only access at /docs.

JSON
1{
2 "mcpServers": {
3 "airwallex-docs": {
4 "type": "http",
5 "url": "https://mcp-demo.airwallex.com/docs"
6 }
7 }
8}

V0 MCP Configuration

Repl.it

Repl.it is a web-based AI coding agent that only supports remote MCP servers.

Documentation and sandbox tools at /developer. Repl.it initiates OAuth to authenticate with Airwallex.

Repl.it OAuth Flow

Documentation-only access at /docs.

Repl.it MCP Configuration

Local server configuration

The local server is configured via environment variables. Add these to the env block in your MCP settings:

NameDescriptionRequired
AIRWALLEX_SANDBOX_CLIENT_IDClient ID associated with the sandbox API key.No
AIRWALLEX_SANDBOX_API_KEYAPI key (admin or scoped) from the sandbox environment. Must have permissions for the APIs you want to use.No
AIRWALLEX_SANDBOX_ACCOUNT_IDAccount ID for a scoped API key that accesses organization or multi-account resources. Starts with acct_.No
DISABLE_TELEMETRYSet to true to disable telemetry. When enabled, only anonymous tool usage data is collected — no parameters or responses are logged. Default: 0.No

Best practices

Follow these best practices to get the most out of your AI coding assistant with the Airwallex MCP server.

Always mention "Airwallex" in your prompts

When asking your coding assistant about Airwallex products, APIs, or integrations, explicitly mention "Airwallex" in your prompt. This helps the model select the appropriate MCP server and tools.

Examples:

  • Integrate Airwallex's Drop-in Element with this website.
  • Using Airwallex, can you find me test card numbers for the 3D Secure (3DS) authentication failure case?
  • I tried to make a payout with Airwallex and got this error: amount_below_transfer_method_limit. What does that mean?

Use plan mode

Enable plan mode for complex tasks. This allows you to review the agent's planned actions before execution, ensuring you understand and approve each step of the implementation.

If you're using Cursor, you can activate plan mode in either of the following ways:

  • Select Plan from the agent mode dropdown in Cursor's composer.
  • Mention it explicitly in your prompt (for example, "Using plan mode, help me integrate Airwallex Embedded Elements").

Be specific with your requirements

Provide detailed context about your use case, including the specific Airwallex product or feature you're working with, your preferred programming language and framework, the environment (sandbox or production), and any specific business requirements or constraints.

Leverage sandbox credentials

Configure your sandbox API credentials to unlock additional MCP tools for testing and simulation. With sandbox credentials, the agent can:

  • Create test transactions and billing plans.
  • Simulate transfer status updates.
  • Generate payment links for testing.
  • Interact with your sandbox account directly.

This enables end-to-end development and testing workflows without leaving your coding environment.

Example:

  • Can you create a new billing plan on Airwallex called Startup for $29.99/month and create a hosted URL to subscribe to it?

Tools

The Developer MCP server provides different tools depending on which endpoint or deployment you use:

Tool category/developer endpoint/docs endpointLocal server
Documentation tools
Sandbox tools
Billing tools

Documentation tools

Available on: /developer endpoint, /docs endpoint, and local server

NameDescription
search_public_docsSearch the Airwallex documentation. Covers the following sources: Product docs, API reference API, Airwallex.js JS, Payments iOS and Android SDKs
read_integration_best_practicesRead Airwallex integration best practices. This tool provides essential guidelines for API usage, payment handling, SDK implementation, and common pitfalls to avoid. Called automatically before code generation tasks.

Sandbox tools

Available on: /developer endpoint and local server

All data retrieved and actions performed with the tools below are in the authenticated sandbox account.

Core Resources

NameDescription
list_global_accountsList all available global accounts
get_balancesList balances in all currencies
list_depositsList all deposits
simulate_create_depositSimulate a deposit to an available global account
list_linked_accountsList all linked accounts
create_linked_accountCreate a linked account with mandate for direct debit (supports AU, CA, EU, GB, NZ, US banks)
verify_micro_depositsConfirm the linked bank account is usable and owned by the user: submit the micro-deposit amounts credited to that account. In sandbox, use values such as 0.01 and 0.02.
simulate_mandate_operationSimulate direct debit mandate status transitions (only needed for GB bank)
list_direct_debitsList all direct debit transactions
create_direct_debit_depositCreate a direct debit deposit to pull funds from a verified linked account

Transactional FX

NameDescription
get_fx_rateGet current foreign exchange rate for a currency pair
create_fx_quoteCreate a foreign exchange quote for a currency conversion

Payouts

NameDescription
list_transfersList transfers initiated
create_transferInitiate a new transfer to a recipient
simulate_transfer_resultSimulate the status of a transfer
list_beneficiariesList available transfer recipients

Payment Acceptance

NameDescription
list_payment_customersList all payment customers
create_payment_customerCreate a payment customer
list_payment_intentsList all payment intents
create_payment_linkCreate a new payment link
list_payment_linksList created payment links
list_payment_consentsList all payment consents
list_refundsList all refunds
create_refundCreate a refund against a PaymentIntent or PaymentAttempt
list_payment_disputesList all payment disputes
simulate_create_payment_disputeSimulate creating a payment dispute for testing dispute handling
accept_payment_disputeAccept a payment dispute
challenge_payment_disputeChallenge a payment dispute by providing reason and evidence
simulate_escalate_payment_disputeSimulate escalating dispute to next stage
simulate_resolve_payment_disputeSimulate issuing bank's final decision

Issuing

NameDescription
list_cardholdersList all cardholders
create_cardholderCreate a cardholder
list_cardsList all issued cards
create_cardCreate a card with authorization controls and spending limits
list_issuing_transactionsList all card transactions
simulate_create_issuing_transactionSimulate a card transaction
simulate_capture_issuing_transactionSimulate capturing a pending authorization transaction
simulate_reverse_issuing_transactionSimulate reversing a pending authorization transaction
simulate_refund_issuing_transactionSimulate refunding a captured card transaction

Billing tools

Available on: local server only

All data retrieved and actions performed with the tools below are in the authenticated sandbox account.

NameDescription
list_billing_productsList available billing products
list_billing_pricesList available billing prices
create_billing_productCreate a new billing product
create_billing_priceCreate a new billing price
create_billing_checkoutCreate a new hosted billing checkout page

Benefits

  • Faster information retrieval: Instead of searching documentation websites, you receive relevant information directly in your coding environment, with access to your codebase for context.
  • Reduced hallucination: AI models often lack up-to-date knowledge of specific APIs and may generate incorrect code. By providing current documentation and examples through MCP tools, the Airwallex Developer MCP server can reduce inaccurate responses.
  • Workflow automation: You can perform common tasks like creating test resources, simulating actions, and testing integrations using natural language prompts, eliminating context switching between tools.
  • Improved experience: Contextual assistance delivered directly to coding assistants helps you find information faster and write better code, reducing integration time.

Limitations

  • Model dependency: The quality of responses depends on the AI model your coding assistant uses. Different models produce varying results, and no model is perfect.
  • Sandbox only: Direct API testing tools work exclusively in Sandbox environments. Production operations require proper integration through direct API calls.
  • Hallucination reduction, not elimination: While providing current documentation reduces incorrect responses, AI models can still generate inaccurate code or responses. Generated code must always be reviewed, validated, and tested before use in production environments.

Feedback

For questions or feedback about the Developer MCP server, contact the Developer Experience team at [email protected].

See also

Was this page helpful?