easypaydirect-mcp

npm docs good first issues license: MIT

📖 Documentation: https://praveendias1180.github.io/easypaydirect-mcp/

Unofficial, read-only Model Context Protocol server for the Easy Pay Direct (EPD) / NMI-family payment gateway.

Give an AI assistant (Claude Desktop, Claude Code, or any MCP client) safe, read-only access to your gateway's transactions, subscriptions, recurring plans, and Customer Vault records — so you can ask questions like "find the failed transactions for this customer last week" or "is this subscription still active?" in plain language.

Easy Pay Direct is built on the NMI / Network Merchants gateway platform, so this server works with any NMI white-label gateway — just point it at your gateway's host. EPD is the headline example, not the limit.

⚠️ Not affiliated with, endorsed by, or sponsored by Easy Pay Direct or NMI. "Easy Pay Direct", "EPD", and "NMI" are trademarks of their respective owners. This is an independent open-source client for their public Query API.

Why read-only?

This server talks only to the gateway's Query API (/api/query.php) — the reporting endpoint. It has no code path to the transaction endpoint (transact.php), so it cannot charge a card, issue a refund, void a transaction, or modify the vault. An LLM connected to this server can look, but it cannot touch money. See docs/security.md.

Write operations may arrive in a future major version — always opt-in, off by default, and loudly gated.

Install & run

Requires Node.js 18+.

# no install needed — run straight from npm
npx easypaydirect-mcp

The server speaks MCP over stdio and expects two environment variables:

Variable	Required	Description
`NMI_SECURITY_KEY`	✅	Your gateway API security key (a read-only key is recommended). Merchant portal → Settings → Security Keys.
`NMI_API_URL`	—	Gateway API base URL. Defaults to `https://secure.nmi.com`. For EPD/white-labels, set this to your gateway's host.

See docs/configuration.md for how to find your key and host.

Connect it to Claude

Claude Desktop — add to claude_desktop_config.json (see examples/claude-desktop-config.json):

{
  "mcpServers": {
    "easypaydirect": {
      "command": "npx",
      "args": ["-y", "easypaydirect-mcp"],
      "env": {
        "NMI_SECURITY_KEY": "your_read_only_security_key",
        "NMI_API_URL": "https://secure.nmi.com"
      }
    }
  }
}

Claude Code:

claude mcp add easypaydirect \
  -e NMI_SECURITY_KEY=your_read_only_security_key \
  -e NMI_API_URL=https://secure.nmi.com \
  -- npx -y easypaydirect-mcp

Full walkthrough: docs/getting-started.md.

Tools

All tools are read-only. Full reference in docs/tools.md.

Tool	What it does
`get_transaction`	Fetch one transaction by gateway transaction ID.
`search_transactions`	Search transactions by date range + filters (condition, action type, payment type, source, email, order id).
`get_subscription`	Fetch one recurring subscription by ID.
`list_subscriptions`	List recurring subscriptions, optionally by created/updated date range.
`list_recurring_plans`	List recurring billing plans (or one by `plan_id`).
`get_customer_vault_record`	Fetch one stored Customer Vault record by ID.
`list_customer_vault`	List stored Customer Vault records, optionally by date range.

Develop

git clone https://github.com/praveendias1180/easypaydirect-mcp.git
cd easypaydirect-mcp
npm install
npm run build      # compile TypeScript to dist/
npm run typecheck  # type-check only

Local run against the MCP Inspector:

npx @modelcontextprotocol/inspector node dist/index.js

Architecture and how tools map to the Query API: docs/nmi-api-mapping.md.

Roadmap

Planned / under consideration — contributions welcome (see open issues):

Tests — unit suite with recorded Query API fixtures (#1)
Friendlier dates — accept ISO-8601 in date filters (#2)
More filters — merchant-defined fields on search_transactions (#3)
Better errors — map NMI response codes to actionable messages (#4)
Distribution — a Docker image (#7) and publish-on-release automation (#8)
Docs — response-field reference (#9)

Read-only stays the default posture — any write support would be a separate, opt-in, gated major version.

See the changelog for released changes.

Contributing

Contributions are welcome — this aims to be a small, dependable, read-only MCP server. See CONTRIBUTING.md for the ground rules and dev setup.

New here? Start with a good first issue — each one has context, a task checklist, file pointers, and acceptance criteria. Have a question? Open a Discussion.