支付集成服务器

Cashfree MCP服务器允许AI工具和代理通过模型上下文协议(MCP)与Cashfree API(支付网关、支付和SecureID)集成。

  • by cashfree
  • TypeScript
  • 本地部署
  • 15 星标
  • 更新于
在 GitHub 查看 cashfree/cashfree-mcp

使用说明

无现金MCP服务器

无现金MCP服务器允许AI工具和代理与 无现金 API(支付网关、支付和安全ID)使用 模型上下文协议(MCP).

设置

克隆存储库

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 或者根据需要调整包版本。

第二步:构建项目

npm run build

这将源文件编译为 dist/ 目录,这是运行MCP服务器所必需的。

🛠️ 如果您在中看到与丢失文件相关的错误 /dist,确保您已成功运行构建步骤。

配置

您将需要一个具有API证书的无现金帐户(我们同时支持沙箱和生产密钥)。您可以在您最喜欢的客户端中使用无现金MCP,下面显示了一些示例配置:

克劳德

将以下配置块添加到您的 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代码设置中

{
  "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证书

为每个服务设置以下环境变量: 支付网关:

  • PAYMENTS_APP_ID:您的支付网关客户端ID
  • PAYMENTS_APP_SECRET:您的支付网关客户端密码

支出:

  • PAYOUTS_APP_ID:您的支付客户ID
  • PAYOUTS_APP_SECRET:您的Payouts客户机密
  • TWO_FA_PUBLIC_KEY_PEM_PATH:2FA公钥的路径(仅在启用2FA时才需要)

安全ID:

  • SECUREID_APP_ID:您的SecureID客户端ID
  • SECUREID_APP_SECRET:您的SecureID客户端密码
  • TWO_FA_PUBLIC_KEY_PEM_PATH:2FA公钥的路径(仅在启用2FA时才需要)

环境

ENV:设置为 production 对于生产环境, sandbox 对于沙盒(默认值: sandbox)

工具配置

TOOLS:以逗号分隔的要启用的模块列表。可用选项:

  • pg:支付网关API
  • payouts:支付API
  • secureid:安全ID API

激发配置

ELICITATION_ENABLED:设置为 true 为了实现交互式参数启发, false 禁用(默认值: false)

启用后,MCP服务器将提示用户缺少必需的参数,而不是因验证错误而失败。这通过要求用户为最初未提供的必填字段提供值来提供更具交互性的体验。

工具

无现金MCP提供以下工具,按产品类别分组

支付网关(PG)

工具名称 描述
搜索 在无现金支付开发人员文档中搜索。
获取输入源帮助 获取处理输入源变量错误的全面说明。
创建付款链接 创建新的付款链接。
获取付款链接详细信息 查看付款链接的所有详细信息和状态。
取消付款链接 取消活动的付款链接。已取消的链接不能再付款
按订单付费链接 查看付款链接的所有订单详细信息。
创建订单 使用Cashfree创建订单,以获得交易的payment_sessions_id
获取订单 使用order_id获取订单详细信息
延长订单 获取扩展订单数据,如地址、购物车、优惠、客户详细信息等
获取符合条件的付款方式 获取给定订单金额和ID的合格付款方式
获得订单付款 查看订单的所有付款详细信息。
通过id获得付款 查看付款ID订单的付款详细信息
创建退款 启动退款。
获得订单的所有退款 获取订单处理的所有退款。
获得退款 获取在您的无现金账户上处理的特定退款。
获得所有定居点 通过指定结算ID、结算UTR或日期范围获取所有结算详细信息。
拆分和结算按顺序定制-id-v2-0 获取拆分和结算详细信息,包括订单中供应商的已结算/未结算交易
按订单id获取结算 查看特定订单的所有结算。
按订单id获取争议 按订单ID获取所有争议详细信息
通过付款id获取争议 通过付款ID获取所有争议详细信息
通过争议id获取争议 通过争议ID获取争议详细信息
通过争议id接受争议 通过争议ID接受争议
通过争议id提交证据对争议进行抗辩 提交证据以反驳争议
模拟付款 模拟测试付款。需要事先创建订单
获取模拟 获取模拟付款详细信息

支付款项

工具名称 描述
标准变速器-v2 在无现金支付中发起金额转账。
get-transfer-status-v2 获取已启动传输的状态。
batch-transfer-v2 在Cashfree Payments发起批量转账请求。
get-batch-transfer-status-v2 获取已启动批处理传输的状态。
授权 使用Cashfree系统进行身份验证,并获取授权持有者令牌。
创建现金计划 创建Cashgram。
停用现金出纳 停用Cashgram。
获取现金状态 获取已创建Cashgram的状态。

安全标志符

工具名称 描述
验证名称是否匹配 用变体验证名称。
生成kyc链接 生成KYC信息验证表。
获取kyc链接状态 获取KYC验证表的状态
生成静态kyc链接 生成一个静态KYC链接。
停用静态kyc链接 停用静态KYC链接。

许可证

该项目根据麻省理工学院开源许可证条款获得许可。请参阅许可证以了解完整条款。

文档

有关API的详细文档,请访问 无现金API文档.

支持

如需支持,请联系 care@cashfree.com 或在 GitHub存储库.