Cashfree MCP Server
by
Enables AI tools and agents to interact with Cashfree payment, payouts, and SecureID services through the Model Context Protocol.
Cashfree MCP Server Overview
Cashfree MCP Server
What is Cashfree MCP Server about?
Provides a Model Context Protocol (MCP) server that exposes Cashfree Payment Gateway, Payouts, and SecureID APIs, allowing AI agents and tools to perform financial operations such as creating payment links, processing refunds, initiating payouts, and verifying KYC data.
How to use Cashfree MCP Server?
- Clone the repository and install dependencies with
npm install. - Build the project using
npm run buildto generate thedist/folder. - Run the server – typically via
node dist/index.js– and configure the required environment variables (client IDs, secrets, environment mode, and enabled tools). - Integrate the server with your AI client (e.g., Claude, VS Code) by adding a server entry that points to the compiled entry script and supplies the environment variables.
Key features of Cashfree MCP Server
- Unified access to Cashfree Payment Gateway, Payouts, and SecureID APIs through a single MCP endpoint.
- Toolset covering payment link creation, order management, refunds, settlements, dispute handling, payout transfers, batch transfers, cashgram operations, and KYC verification.
- Environment selection (
sandboxorproduction) via theENVvariable. - Modular activation of specific services using the
TOOLScomma‑separated list (e.g.,pg,payouts,secureid). - Built‑in documentation links and a searchable developer docs tool.
Use cases of Cashfree MCP Server
- AI‑driven checkout assistants that can generate payment links or process refunds on behalf of users.
- Automated payout systems for marketplaces, enabling agents to trigger single or batch transfers.
- KYC verification bots that generate and monitor SecureID links during onboarding.
- Customer support agents that fetch order, payment, settlement, or dispute details in real time.
FAQ from the Cashfree MCP Server
Q: Which Node.js version is required?
A: v14.x or higher; v20+ is recommended to avoid peer‑dependency issues.
Q: How do I enable only the Payment Gateway tools?
A: Set TOOLS="pg" in the environment configuration.
Q: Where do I place my 2FA public key?
A: Provide the absolute path in TWO_FA_PUBLIC_KEY_PEM_PATH; required only if 2FA is activated for payouts or SecureID.
Q: Can I run the server without building?
A: The source is TypeScript; you must run npm run build to produce the executable files in dist/.
Q: How do I switch to production credentials?
A: Change ENV to production and replace the sandbox client IDs/secrets with live ones.
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
- 10 days ago
Configuration
{
"mcpServers": {
"cashfree": {
"command": "npx",
"args": [
"-y",
"cashfree-mcp"
],
"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>",
"SECUREID_APP_ID": "<YOUR_SECUREID_CLIENT_ID>",
"SECUREID_APP_SECRET": "<YOUR_SECUREID_CLIENT_SECRET>",
"TWO_FA_PUBLIC_KEY_PEM_PATH": "<PATH_TO_PUBLIC_KEY_PEM>",
"TOOLS": "pg,payouts,secureid",
"ENV": "sandbox"
}
}
}
}Configure Clients
Similar MCP Servers like Cashfree MCP Server
Explore related MCPs that share similar capabilities and solve comparable challenges
Goat
by goat-sdk
Enables AI agents to send and receive payments, purchase goods and services, execute investment strategies, tokenize assets, and obtain financial insights by leveraging blockchains, stablecoins, and wallets.
Financial Datasets MCP Server
by financial-datasets
Provides access to income statements, balance sheets, cash flow statements, stock prices, market news, and cryptocurrency data through MCP tools for AI assistants.
Alpaca MCP Server
Officialby alpacahq
Enables large language models to trade stocks and options, retrieve real‑time and historical market data, and manage portfolios using plain English commands through a local or remote MCP server.
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.
Sec Edgar Mcp
by stefanoamorelli
Provides an MCP server that connects AI models to SEC EDGAR filings, enabling real‑time retrieval of company filings, financial statements, and insider‑trading data with exact XBRL precision and verifiable filing references.
MetaTrader MCP Server
by ariadng
Enables AI LLMs to execute trades on the MetaTrader 5 platform through the Model Context Protocol.
Alpha Vantage MCP Server
Officialby calvernaz
Provides access to Alpha Vantage stock market data via an MCP server, supporting stdio and HTTP streaming modes with optional OAuth 2.1 authentication.
Freqtrade Mcp
by kukapay
Integrates the Freqtrade cryptocurrency trading bot with MCP, exposing its REST API as tools for AI agents to perform automated trading operations.
Crypto Indicators MCP Server
by kukapay
Provides a comprehensive set of cryptocurrency technical analysis indicators and ready‑to‑use trading strategies through an MCP interface, enabling AI agents and applications to generate buy, hold, or sell signals.