cashfree
服务介绍
Cashfree MCP 服务器
Cashfree MCP 服务器允许 AI 工具和代理通过 Model Context Protocol (MCP) 与 Cashfree API(支付网关、批量付款和 SecureID)进行集成。
设置
克隆仓库
bash
git clone https://github.com/cashfree/cashfree-mcp.git
cd cashfree-mcp
安装依赖
bash
npm install
(需要 Node.js 14.x 或更高版本)
配置
您需要一个带有 API 凭证的 Cashfree 账户(我们支持沙盒和生产密钥)。您可以在您喜欢的客户端中使用 Cashfree MCP,下面是一些示例配置:
Claude
在您的 claude_desktop_config.json 中添加以下配置块
json
{
"mcpServers": {
"cashfree": {
"command": "node",
"args": ["/path/to/cashfree-mcp/src/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"
}
}
}
}
VS Code
在您的 VS Code 设置中添加以下配置块
json
{
"mcp": {
"inputs": [],
"servers": {
"cashfree": {
"command": "node",
"args": ["/path/to/cashfree-mcp/src/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"
}
}
}
}
}
API 凭证
为每个服务设置以下环境变量:
支付网关:
PAYMENTS_APP_ID: 您的支付网关客户端 IDPAYMENTS_APP_SECRET: 您的支付网关客户端密钥
批量付款:
PAYOUTS_APP_ID: 您的批量付款客户端 IDPAYOUTS_APP_SECRET: 您的批量付款客户端密钥TWO_FA_PUBLIC_KEY_PEM_PATH: 您的2FA公钥路径(仅当启用2FA时需要)
SecureID:
SECUREID_APP_ID: 您的 SecureID 客户端 IDSECUREID_APP_SECRET: 您的 SecureID 客户端密钥TWO_FA_PUBLIC_KEY_PEM_PATH: 您的2FA公钥路径(仅当启用2FA时需要)
环境
ENV: 对于生产环境设置为 production,对于沙盒环境设置为 sandbox(默认: sandbox)
工具配置
TOOLS: 启用模块的逗号分隔列表。可用选项:
pg: 支付网关 APIpayouts: 批量付款 APIsecureid: SecureID API
工具
Cashfree MCP 提供了以下工具,按产品类别分组
支付网关 (PG)
| 工具名称 | 描述 |
|---|---|
| search | 在 Cashfree 支付开发者文档中搜索。 |
| 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 | 通过支付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 | 通过订单ID获取所有争议详情 |
| get-disputes-by-payment-id | 通过支付ID获取所有争议详情 |
| get-disputes-by-dispute-id | 通过争议ID获取争议详情 |
| accept-dispute-by-dispute-id | 通过争议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系统进行身份验证并获取授权Bearer令牌。 |
| 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文档。
支持
如需支持,请联系care@cashfree.com或在GitHub仓库中提出问题。