cashfree-mcp

Cashfree MCP 服务

Cashfree MCP 服务允许 AI 工具和 Agent 使用 Model Context Protocol (MCP) 集成 Cashfree API（Payment Gateway、Payouts 和 SecureID）。

设置

克隆代码库

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

安装依赖项

安装前，请确保已安装 Node.js v14.x 或更高版本。如果使用 nvm 或 brew，请确保已启用正确的版本：

node -v
# Should output v14.x or higher

步骤 1：安装项目依赖项

npm install

这将安装 package.json 中列出的所有必需软件包。

💡 如果使用 Node.js >=18，可能会遇到与 undici 等软件包有关的对等依赖项问题。在这种情况下，请将 Node.js 升级到 >=20.18.1，或根据需要调整软件包版本。

步骤 2：构建项目

npm run build

这会将源文件编译到 dist/ 目录中，运行 MCP 服务需要此目录。

🛠️ 如果看到与 /dist 中缺少文件有关的错误，请确保已成功完成构建步骤。

配置

你需要拥有 Cashfree 账户和 API 凭据（支持沙盒和生产密钥）。你可以在常用的客户端中使用 Cashfree MCP，以下是一些配置示例：

Claude

将以下配置块添加到 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

将以下配置块添加到 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"
        }
      }
    }
  }
}

API 凭据

为每项服务设置以下环境变量： Payment Gateway：

• PAYMENTS_APP_ID：你的 Payment Gateway 客户端 ID
• PAYMENTS_APP_SECRET：你的 Payment Gateway 客户端密钥

Payouts：

• PAYOUTS_APP_ID：你的 Payouts 客户端 ID
• PAYOUTS_APP_SECRET：你的 Payouts 客户端密钥
• TWO_FA_PUBLIC_KEY_PEM_PATH：你的 2FA 公钥路径（仅在启用 2FA 时需要）

SecureID：

• SECUREID_APP_ID：你的 SecureID 客户端 ID
• SECUREID_APP_SECRET：你的 SecureID 客户端密钥
• TWO_FA_PUBLIC_KEY_PEM_PATH：你的 2FA 公钥路径（仅在启用 2FA 时需要）

环境

ENV：生产环境设为 production，沙盒环境设为 sandbox（默认值：sandbox）

工具配置

TOOLS：以逗号分隔的模块列表，用于启用相应模块。可用选项：

• pg：Payment Gateway API
• payouts：Payouts API
• secureid：SecureID API

信息征询配置

ELICITATION_ENABLED：设为 true 可启用交互式参数征询，设为 false 可禁用（默认值：false）

启用后，MCP 服务会在缺少必需参数时向用户发出提示，而不是因验证错误而失败。系统会要求用户为最初未提供的必需字段输入值，从而提供更具交互性的体验。

工具

Cashfree MCP 提供以下工具，按产品类别分组

Payment Gateway (PG)

工具名称	描述
search	搜索 Cashfree Payments 开发者文档。
get-input-source-help	获取处理输入源变量错误的完整说明。
create-payment-link	创建新的付款链接。
fetch-payment-link-details	查看付款链接的所有详细信息和状态。
cancel-payment-link	取消有效的付款链接。取消后，无法再通过这些链接付款。
get-orders-for-a-payment-link	查看付款链接的所有订单详情。
create-order	在 Cashfree 创建订单，以获取用于交易的 payment_sessions_id
get-order	使用 order_id 获取订单详情
get-order-extended	获取扩展订单数据，例如地址、购物车、优惠、客户详情等
get-eligible-payment-methods	获取指定订单金额和 ID 可用的付款方式
get-payments-for-an-order	查看订单的所有付款详情。
get-payment-by-id	查看订单中指定 Payment ID 的付款详情。
create-refund	发起退款。
get-all-refunds-for-an-order	获取针对订单处理的所有退款。
get-refund	获取 Cashfree 账户中处理的指定退款。
get-all-settlements	指定结算 ID、结算 UTR 或日期范围，获取所有结算详情。
get-split-and-settlement-details-by-order-id-v2-0	获取分账和结算详情，包括订单中供应商的已结算／未结算交易
get-settlements-by-order-id	查看指定订单的所有结算。
get-disputes-by-order-id	根据 Order ID 获取所有争议详情
get-disputes-by-payment-id	根据 Payment ID 获取所有争议详情
get-disputes-by-dispute-id	根据 Dispute ID 获取争议详情
accept-dispute-by-dispute-id	根据 Dispute ID 接受争议
submit-evidence-to-contest-the-dispute-by-dispute-id	提交证据以申诉争议
simulate-payment	模拟付款以进行测试。需要事先创建订单
fetch-simulation	获取模拟付款详情

出款

工具名称	描述
standard-transfer-v2	在 Cashfree Payments 发起金额转账。
get-transfer-status-v2	获取已发起转账的状态。
batch-transfer-v2	在 Cashfree Payments 发起批量转账请求。
get-batch-transfer-status-v2	获取已发起批量转账的状态。
authorize	使用 Cashfree 系统进行身份验证，并获取授权持有者令牌。
create-cashgram	创建 Cashgram。
deactivate-cashgram	停用 Cashgram。
get-cashgram-status	获取已创建 Cashgram 的状态。

SecureID

工具名称	描述
verify-name-match	验证不同写法的姓名是否匹配。
generate-kyc-link	生成 KYC 信息验证表单。
get-kyc-link-status	获取 KYC 验证表单的状态。
generate-static-kyc-link	生成静态 KYC 链接。
deactivate-static-kyc-link	停用静态 KYC 链接。

许可证

本项目采用 MIT 开源许可证。完整条款请参阅 LICENSE。

文档

如需详细的 API 文档，请访问 Cashfree API 文档。

支持

如需支持，请联系 [email protected]，或在 GitHub 仓库中提交问题。