Payman API

Integra com as APIs de pagamento da Payman AI para gerenciar beneficiários, pagamentos e saldos usando linguagem natural.

GitHub

Experimente este MCPPatrocinado

Documentação

Servidor MCP da API Payman

Um servidor MCP (Model Context Protocol) que fornece integração perfeita com as APIs de pagamento da Payman AI, permitindo que assistentes de IA criem beneficiários, pesquisem beneficiários existentes, enviem pagamentos e consultem saldos por meio de linguagem natural.

Visão Geral

Este servidor MCP expõe a funcionalidade de pagamento da Payman AI como ferramentas que podem ser usadas por aplicações de LLM, como o Claude. Ele permite que assistentes de IA realizem as seguintes operações:

Definir chaves de API para autenticação
Criar diferentes tipos de beneficiários (TEST_RAILS, US_ACH, CRYPTO_ADDRESS)
Enviar pagamentos para beneficiários registrados
Pesquisar beneficiários com base em vários critérios
Consultar saldos de conta

Esta implementação segue o padrão Model Context Protocol (MCP), garantindo compatibilidade com qualquer cliente compatível com MCP.

Recursos

Autenticação Segura de API: Gerencie chaves de API com segurança dentro da sessão
Múltiplos Tipos de Beneficiários:
- Beneficiários TEST_RAILS para testes
- Beneficiários US_ACH para transferências bancárias nos EUA
- Beneficiários CRYPTO_ADDRESS para transações com criptomoedas
Operações de Pagamento:
- Enviar pagamentos com valores e observações personalizados
- Recuperar saldos atuais
Capacidades de Pesquisa:
- Pesquisar beneficiários por nome, informações de contato, detalhes de conta, etc.
Tratamento de Erros: Tratamento abrangente de erros para todas as operações da API
Transportes Seguros: Suporta transportes stdio e SSE (Server-Sent Events)

Pré-requisitos

Node.js (v14 ou superior)
npm ou yarn
Uma chave de API da Payman AI

Instalação

Instalação via Smithery

Para instalar o payman_mcp para Claude Desktop automaticamente via Smithery:

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

Clone o repositório:

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

Instale as dependências:
```
npm install
# OR
yarn install
```
Compile o código TypeScript:
```
npm run build
# OR
yarn build
```

Configuração

O servidor não requer arquivos de configuração. As chaves de API são definidas em tempo de execução usando a ferramenta set-api-key.

Executando o Servidor

Modo Standard I/O (para Claude Desktop, etc.)

Execute o servidor no modo stdio, que é compatível com Claude Desktop e clientes MCP similares:

Verifique se o servidor está configurado corretamente:

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

Se tudo estiver certo, você pode agora adicionar o servidor MCP Payman a qualquer cliente.

Para Claude Desktop: Aqui
Para Cursor: Aqui

Modo Server-Sent Events (SSE) (para integração web)

Para executar o servidor com transporte SSE (requer dependências adicionais: express e cors):

node build/payman-server-sse.js

Isso iniciará um servidor web na porta 3001 com os seguintes endpoints:

/sse - O endpoint SSE para comunicação servidor-para-cliente
/messages - O endpoint para mensagens cliente-para-servidor

Integração com Clientes MCP

Claude Desktop

Abra o arquivo de configuração do Claude Desktop:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

Adicione a configuração do servidor:

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

Reinicie o Claude Desktop

Outros Clientes MCP

Para outros clientes MCP, como Cursor, consulte a documentação específica deles para adicionar servidores MCP.

Guia de Uso

Uma vez que o servidor esteja conectado a um cliente MCP, você pode usar as seguintes ferramentas:

Definindo a Chave de API

Primeiro, você precisa definir sua chave de API da Payman:

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

Criando Beneficiários

Beneficiário Test Rails

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

Beneficiário 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

Beneficiário Crypto

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

Enviando Pagamentos

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

Pesquisando Beneficiários

Search for all payees with the name "John"

Consultando Saldo

What's my current balance?

Referência de Ferramentas

`set-api-key`

Define a chave de API da Payman para autenticação.

Parâmetros:
- apiKey (string): A chave de API da Payman

`create-test-rails-payee`

Cria um beneficiário TEST_RAILS para testes.

Parâmetros:
- name (string): Nome do beneficiário
- type (string): "TEST_RAILS" (padrão)
- tags (string[]): Tags opcionais para o beneficiário

`create-us-ach-payee`

Cria um beneficiário US_ACH para transferências bancárias.

Parâmetros:
- type (string): "US_ACH" (padrão)
- accountType (enum): "checking" ou "savings"
- accountNumber (string): O número da conta bancária
- routingNumber (string): O número de roteamento
- accountHolderName (string): O nome do titular da conta
- accountHolderType (enum): "individual" ou "business"
- name (string): Nome para este beneficiário
- Além de parâmetros opcionais adicionais (tags, contactDetails)

`create-crypto-payee`

Cria um beneficiário CRYPTO_ADDRESS para pagamentos com criptomoedas.

Parâmetros:
- type (string): "CRYPTO_ADDRESS" (padrão)
- address (string): O endereço da criptomoeda
- chain (string): O blockchain a ser usado
- currency (string): A criptomoeda/token
- name (string): Nome para este beneficiário
- Além de parâmetros opcionais adicionais (tags, contactDetails)

`send-payment`

Envia um pagamento para um beneficiário.

Parâmetros:
- payeeId (string): ID do beneficiário a ser pago
- amountDecimal (number): Valor a ser enviado
- walletId (string, opcional): Carteira específica a ser usada
- memo (string, opcional): Observação do pagamento
- metadata (object, opcional): Metadados adicionais

`search-payees`

Pesquisa beneficiários com base em vários critérios.

Parâmetros: Múltiplos parâmetros de pesquisa opcionais
- name, contactEmail, accountNumber, etc.

`get-balance`

Recupera o saldo atual da conta.

Parâmetros: Nenhum

Tratamento de Erros

Todas as ferramentas incluem tratamento adequado de erros e retornarão mensagens de erro descritivas se:

A chave de API não tiver sido definida
As solicitações de API falharem
Parâmetros inválidos forem fornecidos
Ocorrerem problemas de rede

Considerações de Segurança

As chaves de API são armazenadas em memória durante a sessão
O servidor não persiste nenhuma credencial em disco
Todas as solicitações à API Payman usam cabeçalhos de autorização adequados
Model Context Protocol para a especificação MCP
Payman AI para a API de pagamento
Zod para validação de entrada