Payman API

Se integra con las APIs de pago de Payman AI para gestionar beneficiarios, pagos y saldos usando lenguaje natural.

Documentación

Servidor MCP de la API de Payman

Un servidor MCP (Protocolo de Contexto de Modelo) que proporciona una integración perfecta con las API de pago de Payman AI, permitiendo a los asistentes de IA crear beneficiarios, buscar beneficiarios existentes, enviar pagos y consultar saldos mediante lenguaje natural.

Descripción general

Este servidor MCP expone la funcionalidad de pago de Payman AI como herramientas que pueden ser utilizadas por aplicaciones LLM como Claude. Permite a los asistentes de IA realizar las siguientes operaciones:

Configurar claves API para autenticación
Crear diferentes tipos de beneficiarios (TEST_RAILS, US_ACH, CRYPTO_ADDRESS)
Enviar pagos a beneficiarios registrados
Buscar beneficiarios según varios criterios
Consultar saldos de cuenta

Esta implementación sigue el estándar del Protocolo de Contexto de Modelo (MCP), garantizando compatibilidad con cualquier cliente compatible con MCP.

Características

Autenticación API segura: Gestione claves API de forma segura dentro de la sesión
Múltiples tipos de beneficiarios:
- Beneficiarios TEST_RAILS para pruebas
- Beneficiarios US_ACH para transferencias bancarias en EE. UU.
- Beneficiarios CRYPTO_ADDRESS para transacciones con criptomonedas
Operaciones de pago:
- Envío de pagos con montos y notas personalizados
- Consulta de saldos actuales
Capacidades de búsqueda:
- Búsqueda de beneficiarios por nombre, información de contacto, detalles de cuenta, etc.
Manejo de errores: Manejo integral de errores para todas las operaciones de la API
Transportes seguros: Compatible con transportes stdio y SSE (Eventos Enviados por el Servidor)

Requisitos previos

Node.js (v14 o superior)
npm o yarn
Una clave API de Payman AI

Instalación

Instalación mediante Smithery

Para instalar payman_mcp para Claude Desktop automáticamente mediante Smithery:

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

Clone el repositorio:

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

Instale las dependencias:
```
npm install
# OR
yarn install
```
Compile el código TypeScript:
```
npm run build
# OR
yarn build
```

Configuración

El servidor no requiere archivos de configuración. Las claves API se configuran en tiempo de ejecución mediante la herramienta set-api-key.

Ejecución del servidor

Modo de Entrada/Salida Estándar (para Claude Desktop, etc.)

Ejecute el servidor en modo stdio, que es compatible con Claude Desktop y clientes MCP similares:

Compruebe si el servidor está configurado correctamente:

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

Si todo está correcto, ahora puede añadir el servidor MCP de Payman a cualquier cliente.

Para Claude Desktop: Aquí
Para Cursor: Aquí

Modo de Eventos Enviados por el Servidor (SSE) (para integración web)

Para ejecutar el servidor con transporte SSE (requiere dependencias adicionales: express y cors):

node build/payman-server-sse.js

Esto iniciará un servidor web en el puerto 3001 con los siguientes endpoints:

/sse - El endpoint SSE para comunicación servidor-a-cliente
/messages - El endpoint para mensajes cliente-a-servidor

Integración con clientes MCP

Claude Desktop

Abra el archivo de configuración de Claude Desktop:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

Añada la configuración del servidor:

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

Reinicie Claude Desktop

Otros clientes MCP

Para otros clientes MCP como Cursor, consulte su documentación específica para añadir servidores MCP.

Guía de uso

Una vez que el servidor esté conectado a un cliente MCP, puede utilizar las siguientes herramientas:

Configuración de la clave API

Primero, debe configurar su clave API de Payman:

Please use the set-api-key tool with my Payman API key: YOUR_API_KEY_HERE

Creación de beneficiarios

Beneficiario Test Rails

Create a test payee named "Test User" with the tag "test"

Beneficiario US ACH

Create a US ACH payee with these details:
- Name: John Doe
- Account Type: checking
- Account Number: 12345678
- Routing Number: 123456789
- Account Holder Name: John Doe
- Account Holder Type: individual

Beneficiario Crypto

Create a crypto payee with:
- Name: Crypto Wallet
- Address: 0x1234567890abcdef
- Chain: ethereum
- Currency: ETH

Envío de pagos

Send a payment of 100 to payee ID "pay_123abc" with the memo "Monthly service"

Búsqueda de beneficiarios

Search for all payees with the name "John"

Consulta de saldo

What's my current balance?

Referencia de herramientas

`set-api-key`

Configura la clave API de Payman para autenticación.

Parámetros:
- apiKey (cadena): La clave API de Payman

`create-test-rails-payee`

Crea un beneficiario TEST_RAILS para pruebas.

Parámetros:
- name (cadena): Nombre del beneficiario
- type (cadena): "TEST_RAILS" (predeterminado)
- tags (cadena[]): Etiquetas opcionales para el beneficiario

`create-us-ach-payee`

Crea un beneficiario US_ACH para transferencias bancarias.

Parámetros:
- type (cadena): "US_ACH" (predeterminado)
- accountType (enumeración): "checking" o "savings"
- accountNumber (cadena): El número de cuenta bancaria
- routingNumber (cadena): El número de ruta
- accountHolderName (cadena): El nombre del titular de la cuenta
- accountHolderType (enumeración): "individual" o "business"
- name (cadena): Nombre para este beneficiario
- Además, parámetros opcionales adicionales (etiquetas, datos de contacto)

`create-crypto-payee`

Crea un beneficiario CRYPTO_ADDRESS para pagos con criptomonedas.

Parámetros:
- type (cadena): "CRYPTO_ADDRESS" (predeterminado)
- address (cadena): La dirección de criptomoneda
- chain (cadena): La cadena de bloques a utilizar
- currency (cadena): La criptomoneda/token
- name (cadena): Nombre para este beneficiario
- Además, parámetros opcionales adicionales (etiquetas, datos de contacto)

`send-payment`

Envía un pago a un beneficiario.

Parámetros:
- payeeId (cadena): ID del beneficiario a pagar
- amountDecimal (número): Monto a enviar
- walletId (cadena, opcional): Cartera específica a utilizar
- memo (cadena, opcional): Nota del pago
- metadata (objeto, opcional): Metadatos adicionales

`search-payees`

Busca beneficiarios según varios criterios.

Parámetros: Múltiples parámetros de búsqueda opcionales
- name, contactEmail, accountNumber, etc.

`get-balance`

Recupera el saldo actual de la cuenta.

Parámetros: Ninguno

Manejo de errores

Todas las herramientas incluyen un manejo de errores adecuado y devolverán mensajes de error descriptivos si:

La clave API no se ha configurado
Las solicitudes a la API fallan
Se proporcionan parámetros no válidos
Ocurren problemas de red

Consideraciones de seguridad

Las claves API se almacenan en memoria durante la duración de la sesión
El servidor no persiste ninguna credencial en disco
Todas las solicitudes a la API de Payman utilizan encabezados de autorización adecuados
Protocolo de Contexto de Modelo para la especificación MCP
Payman AI para la API de pagos
Zod para la validación de entradas