Payman API MCP Server
An MCP (Model Context Protocol) server that provides seamless integration with Payman AI's payment APIs, allowing AI assistants to create payees, search for existing payees, send payments, and check balances through natural language.
Overview
This MCP server exposes Payman AI's payment functionality as tools that can be used by LLM applications such as Claude. It enables AI assistants to perform the following operations:
- Set API keys for authentication
- Create different types of payees (TEST_RAILS, US_ACH, CRYPTO_ADDRESS)
- Send payments to registered payees
- Search for payees based on various criteria
- Check account balances
This implementation follows the Model Context Protocol (MCP) standard, ensuring compatibility with any MCP-compatible client.
Features
- Secure API Authentication: Manage API keys securely within the session
- Multiple Payee Types:
- TEST_RAILS payees for testing
- US_ACH payees for US bank transfers
- CRYPTO_ADDRESS payees for cryptocurrency transactions
- Payment Operations:
- Send payments with custom amounts and memos
- Retrieve current balances
- Search Capabilities:
- Search payees by name, contact information, account details, etc.
- Error Handling: Comprehensive error handling for all API operations
- Secure Transports: Supports both stdio and SSE (Server-Sent Events) transports
Prerequisites
Installation
Installing via Smithery
To install payman_mcp for Claude Desktop automatically via Smithery:
- Clone the repository:Copy
- Install dependencies:Copy
- Build the TypeScript code:Copy
Configuration
The server does not require any configuration files. API keys are set at runtime using the set-api-key
tool.
Running the Server
Standard I/O Mode (for Claude Desktop, etc.)
Run the server in stdio mode, which is compatible with Claude Desktop and similar MCP clients:
Check if the server is properly setup:
If everything is good, you can now add the Payman MCP server to any client.
Server-Sent Events (SSE) Mode (for web integration)
To run the server with SSE transport (requires additional dependencies: express
and cors
):
This will start a web server on port 3001 with the following endpoints:
/sse
- The SSE endpoint for server-to-client communication/messages
- The endpoint for client-to-server messages
Integrating with MCP Clients
Claude Desktop
- Open your Claude Desktop configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
- Add the server configuration:Copy
- Restart Claude Desktop
Other MCP Clients
For other MCP clients like Cursor, refer to their specific documentation for adding MCP servers.
Usage Guide
Once the server is connected to an MCP client, you can use the following tools:
Setting the API Key
First, you need to set your Payman API key:
Creating Payees
Test Rails Payee
US ACH Payee
Crypto Payee
Sending Payments
Searching for Payees
Checking Balance
Tool Reference
set-api-key
Sets the Payman API key for authentication.
- Parameters:
apiKey
(string): The Payman API key
create-test-rails-payee
Creates a TEST_RAILS payee for testing.
- Parameters:
name
(string): Name of the payeetype
(string): "TEST_RAILS" (default)tags
(string[]): Optional tags for the payee
create-us-ach-payee
Creates a US_ACH payee for bank transfers.
- Parameters:
type
(string): "US_ACH" (default)accountType
(enum): "checking" or "savings"accountNumber
(string): The bank account numberroutingNumber
(string): The routing numberaccountHolderName
(string): The name of the account holderaccountHolderType
(enum): "individual" or "business"name
(string): Name for this payee- Plus additional optional parameters (tags, contactDetails)
create-crypto-payee
Creates a CRYPTO_ADDRESS payee for cryptocurrency payments.
- Parameters:
type
(string): "CRYPTO_ADDRESS" (default)address
(string): The cryptocurrency addresschain
(string): The blockchain to usecurrency
(string): The cryptocurrency/tokenname
(string): Name for this payee- Plus additional optional parameters (tags, contactDetails)
send-payment
Sends a payment to a payee.
- Parameters:
payeeId
(string): ID of the payee to payamountDecimal
(number): Amount to sendwalletId
(string, optional): Specific wallet to usememo
(string, optional): Payment memometadata
(object, optional): Additional metadata
search-payees
Search for payees based on various criteria.
- Parameters: Multiple optional search parameters
name
,contactEmail
,accountNumber
, etc.
get-balance
Retrieves the current account balance.
- Parameters: None
Error Handling
All tools include proper error handling and will return descriptive error messages if:
- The API key has not been set
- API requests fail
- Invalid parameters are provided
- Network issues occur
Security Considerations
- API keys are stored in memory for the duration of the session
- The server does not persist any credentials to disk
- All requests to the Payman API use proper authorization headers
- Model Context Protocol for the MCP specification
- Payman AI for the payment API
- Zod for input validation
You must be authenticated.
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
A server that provides easy access to Payman AI's APIs, allowing users to create payees, search payees, send payments, and check balances using natural language prompts.
Related MCP Servers
- AsecurityAlicenseAqualityAn unofficial server that allows AI assistants to access Fathom Analytics data, enabling users to retrieve account information, site statistics, events, aggregated reports, and real-time visitor tracking.Last updated -581TypeScriptMIT License
Fewsats MCP Serverofficial
AsecurityFlicenseAqualityAn MCP server that integrates with Fewsats allowing AI agents to securely purchase anything by retrieving balances, accessing payment methods, and processing payments.Last updated -411Python- -securityFlicense-qualityA Model Context Protocol server that enables Claude AI to interact with Paybyrd's payment processing API, allowing for creating payment links, processing refunds, and retrieving order information.Last updated -5TypeScript
- -securityFlicense-qualityProvides AI assistants like Claude or Cursor with access to Payman AI's documentation, helping developers build integrations more efficiently.Last updated -TypeScript