概览
What is Payman API MCP Server?
An MCP server that integrates Payman AI’s payment APIs, enabling AI assistants to create payees, send payments, search payees, and check balances through natural language.
How to use Payman API MCP Server?
Install via npm, build the TypeScript code, then run in stdio mode for desktop clients or SSE mode for web integration. Set your Payman API key at runtime using the set-api-key tool before using other tools.
Key features of Payman API MCP Server
- Secure API key management (in‑memory only)
- Supports TEST_RAILS, US_ACH, and CRYPTO_ADDRESS payees
- Send payments with custom amounts and memos
- Search payees by name, contact, or account details
- Works over stdio and SSE transports
Use cases of Payman API MCP Server
- AI assistant initiates US ACH bank transfers to vendors
- Test payment workflows with TEST_RAILS payees
- Send cryptocurrency payments via CRYPTO_ADDRESS payees
- Query account balances and search existing payees
FAQ from Payman API MCP Server
How do I set my API key?
Use the set-api-key tool with your Payman AI API key – no configuration file required.
Does the server store my API key on disk?
No, the API key is held in memory only for the duration of the session and is not persisted.
What transport modes are available?
The server supports both stdio (for desktop MCP clients) and SSE (Server‑Sent Events, for web integration).
What are the prerequisites to run the server?
Node.js v14 or higher, npm/yarn, and a Payman AI API key.
Can I create different types of payees?
Yes: TEST_RAILS for testing, US_ACH for US bank transfers, and CRYPTO_ADDRESS for cryptocurrency transactions.
