Cashfree MCP Server

Integre ferramentas e agentes de IA com as APIs de Gateway de Pagamento, Pagamentos e SecureID da Cashfree.

Documentação

Cashfree MCP Server

O servidor MCP da Cashfree permite que ferramentas e agentes de IA se integrem às APIs da Cashfree (Payment Gateway, Payouts e SecureID) usando o Model Context Protocol (MCP).

Configuração

Clonar o Repositório

git clone https://github.com/cashfree/cashfree-mcp.git
cd cashfree-mcp

Instalar Dependências

Antes de instalar, certifique-se de ter o Node.js v14.x ou superior instalado. Se você estiver usando nvm ou brew, verifique se a versão correta está ativa:

node -v
# Should output v14.x or higher

Passo 1: Instalar as dependências do projeto

npm install

Isso instalará todos os pacotes necessários listados em package.json.

💡 Se você estiver usando Node.js >=18, poderá enfrentar problemas de dependências de pares com pacotes como undici. Nesse caso, atualize o Node.js para >=20.18.1 ou ajuste a versão do pacote, se necessário.

Passo 2: Compilar o projeto

npm run build

Isso compila os arquivos de origem para o diretório dist/, que é necessário para executar o servidor MCP.

🛠️ Se você vir erros relacionados a arquivos ausentes em /dist, certifique-se de ter executado a etapa de compilação com sucesso.

Configuração

Você precisará de uma conta Cashfree com credenciais de API (suportamos chaves de sandbox e produção). Você pode usar o Cashfree MCP no seu cliente favorito; algumas configurações de exemplo são mostradas abaixo:

Claude

Adicione o seguinte bloco de configuração ao seu claude_desktop_config.json

{
  "mcpServers": {
    "cashfree": {
      "command": "node",
      "args": ["/path/to/cashfree-mcp/dist/index.js"],
      "env": {
        "PAYMENTS_APP_ID": "YOUR_PG_CLIENT_ID",
        "PAYMENTS_APP_SECRET": "YOUR_PG_CLIENT_SECRET",
        "PAYOUTS_APP_ID": "YOUR_PAYOUTS_CLIENT_ID",
        "PAYOUTS_APP_SECRET": "YOUR_PAYOUTS_CLIENT_SECRET",
        "TWO_FA_PUBLIC_KEY_PEM_PATH": "/path/to/public_key.pem",
        "SECUREID_APP_ID": "YOUR_SECUREID_CLIENT_ID",
        "SECUREID_APP_SECRET": "YOUR_SECUREID_CLIENT_SECRET",
        "TOOLS": "pg,payouts,secureid",
        "ENV": "sandbox",
        "ELICITATION_ENABLED": "true"
      }
    }
  }
}

VS Code

Adicione o seguinte bloco de configuração às configurações do seu VS Code

{
  "mcp": {
    "inputs": [],
    "servers": {
      "cashfree": {
        "command": "node",
        "args": ["/path/to/cashfree-mcp/dist/index.js"],
        "env": {
          "PAYMENTS_APP_ID": "YOUR_PG_CLIENT_ID",
          "PAYMENTS_APP_SECRET": "YOUR_PG_CLIENT_SECRET",
          "PAYOUTS_APP_ID": "YOUR_PAYOUTS_CLIENT_ID",
          "PAYOUTS_APP_SECRET": "YOUR_PAYOUTS_CLIENT_SECRET",
          "TWO_FA_PUBLIC_KEY_PEM_PATH": "/path/to/public_key.pem",
          "SECUREID_APP_ID": "YOUR_SECUREID_CLIENT_ID",
          "SECUREID_APP_SECRET": "YOUR_SECUREID_CLIENT_SECRET",
          "TOOLS": "pg,payouts,secureid",
          "ENV": "sandbox",
          "ELICITATION_ENABLED": "true"
        }
      }
    }
  }
}

Credenciais da API

Defina as seguintes variáveis de ambiente para cada serviço: Payment Gateway:

PAYMENTS_APP_ID: Seu ID de cliente do Payment Gateway
PAYMENTS_APP_SECRET: Seu segredo de cliente do Payment Gateway

Payouts:

PAYOUTS_APP_ID: Seu ID de cliente de Payouts
PAYOUTS_APP_SECRET: Seu segredo de cliente de Payouts
TWO_FA_PUBLIC_KEY_PEM_PATH: Caminho para sua chave pública 2FA (necessário apenas se o 2FA estiver habilitado)

SecureID:

SECUREID_APP_ID: Seu ID de cliente do SecureID
SECUREID_APP_SECRET: Seu segredo de cliente do SecureID
TWO_FA_PUBLIC_KEY_PEM_PATH: Caminho para sua chave pública 2FA (necessário apenas se o 2FA estiver habilitado)

Ambiente

ENV: Defina como production para ambiente de produção, sandbox para sandbox (padrão: sandbox)

Configuração de Ferramentas

TOOLS: Lista separada por vírgulas dos módulos a serem habilitados. Opções disponíveis:

pg: APIs do Payment Gateway
payouts: APIs de Payouts
secureid: APIs do SecureID

Configuração de Elicitação

ELICITATION_ENABLED: Defina como true para habilitar a elicitação interativa de parâmetros, false para desabilitar (padrão: false)

Quando habilitado, o servidor MCP solicitará aos usuários os parâmetros obrigatórios ausentes em vez de falhar com erros de validação. Isso proporciona uma experiência mais interativa, pedindo aos usuários que forneçam valores para campos obrigatórios que não foram fornecidos inicialmente.

Ferramentas

O Cashfree MCP possui as seguintes ferramentas disponíveis, agrupadas por categoria de produto

Payment Gateway (PG)

Nome da Ferramenta	Descrição
search	Pesquisar na documentação para desenvolvedores de pagamentos da Cashfree.
get-input-source-help	Obter instruções abrangentes para lidar com erros de variáveis de origem de entrada.
create-payment-link	Criar um novo link de pagamento.
fetch-payment-link-details	Visualizar todos os detalhes e o status de um link de pagamento.
cancel-payment-link	Cancelar um link de pagamento ativo. Nenhum pagamento adicional pode ser feito em links cancelados.
get-orders-for-a-payment-link	Visualizar todos os detalhes de pedidos de um link de pagamento.
create-order	Criar pedidos com a Cashfree para obter um payment_sessions_id para transações.
get-order	Buscar detalhes do pedido usando order_id.
get-order-extended	Obter dados estendidos do pedido, como endereço, carrinho, ofertas, detalhes do cliente etc.
get-eligible-payment-methods	Obter métodos de pagamento elegíveis para um determinado valor e ID de pedido.
get-payments-for-an-order	Visualizar todos os detalhes de pagamento de um pedido.
get-payment-by-id	Visualizar detalhes de pagamento de um pedido por um ID de pagamento.
create-refund	Iniciar reembolsos.
get-all-refunds-for-an-order	Buscar todos os reembolsos processados contra um pedido.
get-refund	Buscar um reembolso específico processado na sua conta Cashfree.
get-all-settlements	Obter todos os detalhes de liquidação especificando o ID de liquidação, UTR de liquidação ou intervalo de datas.
get-split-and-settlement-details-by-order-id-v2-0	Obter detalhes de divisão e liquidação, incluindo transações liquidadas/não liquidadas para fornecedores em um pedido.
get-settlements-by-order-id	Visualizar todas as liquidações de um pedido específico.
get-disputes-by-order-id	Obter todos os detalhes de disputas por ID de pedido.
get-disputes-by-payment-id	Obter todos os detalhes de disputas por ID de pagamento.
get-disputes-by-dispute-id	Obter detalhes de disputas por ID de disputa.
accept-dispute-by-dispute-id	Aceitar uma disputa pelo seu ID de disputa.
submit-evidence-to-contest-the-dispute-by-dispute-id	Enviar evidências para contestar uma disputa.
simulate-payment	Simular pagamento para testes. Requer criação prévia de pedido.
fetch-simulation	Buscar detalhes de pagamento simulado.

Payouts

Nome da Ferramenta	Descrição
standard-transfer-v2	Iniciar uma transferência de valor na Cashfree Payments.
get-transfer-status-v2	Obter o status de uma transferência iniciada.
batch-transfer-v2	Iniciar uma solicitação de transferência em lote na Cashfree Payments.
get-batch-transfer-status-v2	Obter o status de uma transferência em lote iniciada.
authorize	Autenticar no sistema Cashfree e obter o token de autorização bearer.
create-cashgram	Criar um Cashgram.
deactivate-cashgram	Desativar um Cashgram.
get-cashgram-status	Obter o status de um Cashgram criado.

SecureID

Nome da Ferramenta	Descrição
verify-name-match	Verificar nomes com variações.
generate-kyc-link	Gerar um formulário de verificação para informações KYC.
get-kyc-link-status	Obter o status de um formulário de verificação KYC.
generate-static-kyc-link	Gerar um link KYC estático.
deactivate-static-kyc-link	Desativar um link KYC estático.

Licença

Este projeto está licenciado sob os termos da licença de código aberto MIT. Consulte LICENSE para os termos completos.

Documentação

Para documentação detalhada da API, visite a Documentação da API Cashfree.

Suporte

Para suporte, entre em contato com care@cashfree.com ou abra uma issue no repositório GitHub.