Payman API

Create payees, send payments, search payees and get balance using payman mcp server

javascript

3

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "hrishi0102-payman_mcp": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/payman-mcp-server/build/payman-server.js"
      ]
    }
  }
}

This MCP server exposes Payman AI's payment capabilities to MCP-compatible clients, enabling you to securely manage API keys, create diverse payees, send payments, search for payees, and check balances using natural language interfaces. It supports multiple transport modes and endpoints so you can integrate payment actions into your AI workflows with ease.

How to use

Connect to this MCP server from any MCP-enabled client to perform payment operations through natural language tools. You can set your authentication key once per session, create different payee types, issue payments, search for payees, and retrieve your balance. The server supports standard I/O transport for local applications and Server-Sent Events (SSE) for web integrations. Use the provided tools to interact with Payman AI’s payment APIs just as you would with built-in functions.

How to install

Prerequisites: Node.js (v14 or higher) and npm or yarn. Have a Payman AI API key ready for authentication.

npx -y @smithery/cli install @hrishi0102/payman_mcp --client claude

git clone https://github.com/yourusername/payman-mcp-server.git
cd payman-mcp-server

npm install
# OR
yarn install

npm run build
# OR
yarn build

Running the server

You have two options to run the server depending on your integration scenario.

node /ABSOLUTE/PATH/TO/PARENT/FOLDER/payman-mcp-server/build/payman-server.js

node build/payman-server-sse.js

Integrating with clients

To use with Claude Desktop or other MCP clients, start the appropriate server process and configure the client to connect via the local stdio channel or SSE endpoints as described by your client’s MCP setup.

Usage notes

Set your API key using the dedicated set-api-key tool at runtime. Then you can create payees, send payments, search for payees, and check balances using natural language commands supported by the MCP server.

Available tools

set-api-key

Sets the Payman API key for authentication in the current session.

create-test-rails-payee

Creates a TEST_RAILS payee for testing purposes.

create-us-ach-payee

Creates a US_ACH payee with bank transfer details including account and routing numbers.

create-crypto-payee

Creates a CRYPTO_ADDRESS payee for cryptocurrency payments.

send-payment

Sends a specified amount to a chosen payee with optional memo and metadata.

search-payees

Searches for payees by name, contact details, or account information.

get-balance

Retrieves the current account balance.