Skip to main content

MCP Server (Beta)

Connect AI assistants to Merchant Hub using the Model Context Protocol (MCP). Search orders, manage accounts, view settlements, and more β€” directly from your AI-powered tools.

Beta

The MCP Server is currently in beta. Features and endpoints may change without prior notice. We welcome feedback to help us improve the experience.

Have a specific use case?

We're happy to hear how you plan to use the MCP Server. If you have a specific use case or need additional tools or adaptations, please contact us β€” we'd love to work with you to tailor the experience.

What is MCP?​

The Model Context Protocol (MCP) is an open standard that allows AI assistants and tools to interact with external systems through a well-defined set of capabilities called tools. The Merchant Hub MCP Server exposes Merchant Hub operations as MCP tools, enabling AI assistants like M365 Copilot, custom chat bots, and other MCP-compatible clients to work with your merchant data conversationally.

Environments​

EnvironmentMCP Endpoint
Testhttps://merchanthub-mcp.aks.uat.walleydev.com/mcp
Productionhttps://mcp.merchanthub.walleypay.com/mcp

Authentication​

The MCP Server supports two authentication methods:

  • Browser flow β€” For interactive use, your MCP client opens a browser where you sign in with your Merchant Hub account. To use this please contact us first.
  • API key flow β€” For automated integrations, use a client ID and secret to request a Bearer token via the Client Credentials grant.

See Authentication for a step-by-step guide on both methods.

Connecting Your AI Client​

The MCP Server uses HTTP transport (Streamable HTTP). Configuration varies by client, but typically you need to provide:

  • URL: The MCP endpoint for your environment (see table above)
  • Headers: An Authorization header with your Bearer token

Example: VS Code / GitHub Copilot​

Add the following to your .vscode/mcp.json or user settings:

{
"servers": {
"walley-merchanthub": {
"type": "http",
"url": "https://merchanthub-mcp.aks.uat.walleydev.com/mcp",
"headers": {
"Authorization": "Bearer <your-token>"
}
}
}
}

Available Tools​

Once connected, your AI assistant can use the following tools:

ToolDescription
SearchOrderSearch orders with pagination, sorting, and full-text filtering. Supports date filters on placedAt and expiresAt.
GetOrderByIdFetch a single order by its ID.
SearchSettlementSearch settlements (reports) with pagination, sorting, and full-text filtering. Supports date filters on startDate, endDate, and paidOutAt.
GetSettlementTransactionsFetch transactions for a specific settlement by its ID, with pagination support.

Usage Examples​

Here are some examples of what you can ask your AI assistant once connected:

  • "Show me orders placed in the last 7 days"
  • "Find order 12345 and show me its details"
  • "Search for orders with status 'Activated'"
  • "Show me settlements paid out this month"
  • "List the transactions for settlement ABC-123"

Permissions​

The MCP Server respects the same permissions as Merchant Hub. The tools available and the data returned depend on the permissions granted to the authenticated user. If a tool returns an authorization error, verify that the user has the appropriate permissions in Merchant Hub under Manage Organization.

Data Security Disclaimer​

Important

When using the MCP Server with AI assistants, order and settlement data β€” which may include personal and sensitive information β€” is sent to the AI model for processing. It is the merchant's responsibility to take adequate measures to ensure that no data is leaked or exposed to unauthorized parties. This includes, but is not limited to, evaluating the AI tools and models you connect to, ensuring compliance with applicable data protection regulations (e.g. GDPR), and restricting access to authorized personnel only. We are not responsible for any data handling that occurs outside of the MCP Server itself.