Cashfree MCP Server
by
Enables AI tools and agents to interact with Cashfree APIs (Payment Gateway, Payouts, SecureID) via the Model Context Protocol.
Cashfree MCP Server Overview
What is Cashfree MCP Server about?
Enables AI tools and agents to call Cashfree Payment Gateway, Payouts, and SecureID endpoints programmatically, exposing each operation as an MCP‑compatible tool.
How to use Cashfree MCP Server?
- Clone the repository and install Node.js ≥ 14.
- Run
npm installto fetch dependencies. - Build the TypeScript sources with
npm run build(outputs todist/). - Configure environment variables for the required services (see Configuration section).
- Start the server by executing the compiled entry point, e.g.,
node path/to/cashfree-mcp/dist/index.js. - Register the MCP server in the client of choice (Claude, VS Code, etc.) by providing the command, arguments, and environment variables as shown in the README.
Key Features
- Unified toolset covering Payment Gateway, Payouts, and SecureID operations.
- Search across Cashfree developer documentation.
- Full lifecycle support for payment links, orders, refunds, settlements, and disputes.
- Batch and standard transfers for payouts, with status tracking.
- KYC verification utilities (generate links, check status, static links).
- Environment selection (
sandboxorproduction). - Selectable modules via
TOOLS(comma‑separated list).
Use Cases
- Integrating payment‑link creation into a conversational AI assistant.
- Automating refunds or dispute handling through an AI‑driven support bot.
- Enabling AI agents to trigger bulk payouts for payroll or vendor settlements.
- Providing real‑time KYC verification within an identity‑verification workflow.
- Building custom AI‑powered dashboards that fetch order, settlement, or payout data on demand.
FAQ
Q: Which Node.js version is required? A: v14.x or higher; for best compatibility use v20.18.1 or later.
Q: How do I switch between sandbox and production?
A: Set the ENV environment variable to sandbox (default) or production.
Q: Can I enable only specific services?
A: Yes, list desired modules in the TOOLS variable (e.g., pg,payouts).
Q: What credentials are needed?
A: Provide client ID and secret for each service (PAYMENTS_APP_ID, PAYMENTS_APP_SECRET, PAYOUTS_APP_ID, etc.) and, if 2FA is used, the path to the public key (TWO_FA_PUBLIC_KEY_PEM_PATH).
Q: How is the server started in a client configuration? A: Use a command block like:
{
"command": "node",
"args": ["/path/to/cashfree-mcp/dist/index.js"],
"env": { "PAYMENTS_APP_ID": "...", "...": "..." }
}
Cashfree MCP Server's README
Cashfree MCP Server
Cashfree MCP server allows AI tools and agents to integrate with Cashfree APIs (Payment Gateway, Payouts, and SecureID) using the Model Context Protocol (MCP).
Setup
Clone the Repository
git clone https://github.com/cashfree/cashfree-mcp.git
cd cashfree-mcp
Install Dependencies
Before installing, ensure you have Node.js v14.x or higher installed. If you're using nvm or brew, make sure the correct version is active:
node -v
# Should output v14.x or higher
Step 1: Install project dependencies
npm install
This will install all required packages listed in package.json.
💡 If you're using
Node.js >=18, you might face peer dependency issues with packages likeundici. In that case, upgrade Node.js to>=20.18.1or adjust the package version if needed.
Step 2: Build the project
npm run build
This compiles the source files to the dist/ directory, which is required to run the MCP server.
🛠️ If you see errors related to missing files in
/dist, ensure you've run the build step successfully.
Configuration
You will need a Cashfree account with API credentials (we support both sandbox and production keys). You can use Cashfree MCP in your favorite client, some sample configurations are shown below:
Claude
Add the following configuration block to your 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"
}
}
}
}
VS Code
Add the following configuration block to your VS Code settings
{
"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"
}
}
}
}
}
API Credentials
Set the following environment variables for each service: Payment Gateway:
PAYMENTS_APP_ID: Your Payment Gateway client IDPAYMENTS_APP_SECRET: Your Payment Gateway client secret
Payouts:
PAYOUTS_APP_ID: Your Payouts client IDPAYOUTS_APP_SECRET: Your Payouts client secretTWO_FA_PUBLIC_KEY_PEM_PATH: Path to your 2FA public key (required only if 2FA is enabled)
SecureID:
SECUREID_APP_ID: Your SecureID client IDSECUREID_APP_SECRET: Your SecureID client secretTWO_FA_PUBLIC_KEY_PEM_PATH: Path to your 2FA public key (required only if 2FA is enabled)
Environment
ENV: Set to production for production environment, sandbox for sandbox (default: sandbox)
Tools Configuration
TOOLS: Comma-separated list of modules to enable. Available options:
pg: Payment Gateway APIspayouts: Payouts APIssecureid: SecureID APIs
Tools
Cashfree MCP has the following tools available, grouped by the product category
Payment Gateway (PG)
| Tool Name | Description |
|---|---|
| search | Search across the Cashfree Payments Developer Documentation. |
| create-payment-link | Create a new payment link. |
| fetch-payment-link-details | View all details and status of a payment link. |
| cancel-payment-link | Cancel an active payment link. No further payments can be done against cancelled links |
| get-orders-for-a-payment-link | View all order details for a payment link. |
| create-order | Create orders with Cashfree to get a payment_sessions_id for transactions |
| get-order | Fetch order details using order_id |
| get-order-extended | Get extended order data like address, cart, offers, customer details etc |
| get-eligible-payment-methods | Get eligible payment methods for a given order amount and ID |
| get-payments-for-an-order | View all payment details for an order. |
| get-payment-by-id | View payment details of an order for a Payment ID. |
| create-refund | Initiate refunds. |
| get-all-refunds-for-an-order | Fetch all refunds processed against an order. |
| get-refund | Fetch a specific refund processed on your Cashfree Account. |
| get-all-settlements | Get all settlement details by specifying the settlement ID, settlement UTR, or date range. |
| get-split-and-settlement-details-by-order-id-v2-0 | Get split and settlement details, including settled/unsettled transactions for vendors in an order |
| get-settlements-by-order-id | View all the settlements of a particular order. |
| get-disputes-by-order-id | Get all dispute details by Order ID |
| get-disputes-by-payment-id | Get all dispute details by Payment ID |
| get-disputes-by-dispute-id | Get dispute details by Dispute ID |
| accept-dispute-by-dispute-id | Accept a dispute by its Dispute ID |
| submit-evidence-to-contest-the-dispute-by-dispute-id | Submit evidence to contest a dispute |
| simulate-payment | Simulate payment for testing. Requires prior order creation |
| fetch-simulation | Fetch simulated payment details |
Payouts
| Tool Name | Description |
|---|---|
| standard-transfer-v2 | Initiate an amount transfer at Cashfree Payments. |
| get-transfer-status-v2 | Get the status of an initiated transfer. |
| batch-transfer-v2 | Initiate a batch transfer request at Cashfree Payments. |
| get-batch-transfer-status-v2 | Get the status of an initiated batch transfer. |
| authorize | Authenticate with the Cashfree system and obtain the authorization bearer token. |
| create-cashgram | Create a Cashgram. |
| deactivate-cashgram | Deactivate a Cashgram. |
| get-cashgram-status | Get the status of a created Cashgram. |
SecureID
| Tool Name | Description |
|---|---|
| verify-name-match | Verify names with variations. |
| generate-kyc-link | Generate a verification form for KYC information. |
| get-kyc-link-status | Get the status of a KYC verification form. |
| generate-static-kyc-link | Generate a static KYC link. |
| deactivate-static-kyc-link | Deactivate a static KYC link. |
License
This project is licensed under the terms of the MIT open source license. Please refer to LICENSE for the full terms.
Documentation
For detailed API documentation, visit the Cashfree API Documentation.
Support
For support, contact care@cashfree.com or raise an issue in the GitHub repository.
Cashfree MCP Server Reviews
Login Required
Please log in to share your review and rating for this MCP.
Actions
Cashfree MCP Server's Information
- Author
- cashfree
- Category
- Finance & Payments
- Language
- TypeScript
- License
- Other
- Version
- v1.0.0
- Stars
- 8
- Updated
- about 2 months ago
Related MCP Servers
Discover more MCP servers with similar functionality and use cases
Stripe Agent Toolkit
by stripe
Enables popular agent frameworks to integrate with Stripe APIs via function calling, providing tools for MCP, Python, and TypeScript.
GOAT
by goat-sdk
GOAT is the largest agentic finance toolkit for AI agents, enabling them to become economic actors by leveraging blockchains, cryptocurrencies, and wallets.
Financial Datasets MCP Server
by financial-datasets
Provides AI assistants with tools to retrieve income statements, balance sheets, cash flow statements, stock prices, market news, and crypto information via the Model Context Protocol.
Razorpay MCP Server
by razorpay
Enables seamless interaction with Razorpay APIs via Model Context Protocol, allowing developers and AI agents to capture payments, manage orders, process refunds, handle settlements, and more through a unified MCP interface.
Armor Crypto MCP
Officialby armorwallet
Armor Crypto MCP provides a unified interface for AI agents to interact with the crypto ecosystem, including wallet management, swaps, staking, and multi-chain operations.
Alpaca
Officialby alpacahq
Alpaca’s MCP server lets you trade stocks and options, analyze market data, and build strategies through Alpaca's Trading API.
Xero MCP Server
by XeroAPI
Provides a bridge between the Model Context Protocol and Xero's API, enabling standardized access to Xero accounting and business features.
Freqtrade MCP
by kukapay
Integrates the Freqtrade cryptocurrency trading bot with an MCP server, exposing the bot's REST API as tools that AI agents can call for fully automated trading operations.
Crypto Indicators
by kukapay
Offers over 50 cryptocurrency technical analysis indicators and corresponding trading strategies, enabling AI agents and developers to assess market trends and generate buy, hold, or sell signals.