- Home
- MCP servers
- Cashfree
Cashfree
- typescript
12
GitHub Stars
typescript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"cashfree-cashfree-mcp": {
"command": "node",
"args": [
"/path/to/cashfree-mcp/dist/index.js"
],
"env": {
"ENV": "sandbox",
"TOOLS": "pg,payouts,secureid",
"PAYOUTS_APP_ID": "YOUR_PAYOUTS_CLIENT_ID",
"PAYMENTS_APP_ID": "YOUR_PG_CLIENT_ID",
"SECUREID_APP_ID": "YOUR_SECUREID_CLIENT_ID",
"PAYOUTS_APP_SECRET": "YOUR_PAYOUTS_CLIENT_SECRET",
"ELICITATION_ENABLED": "true",
"PAYMENTS_APP_SECRET": "YOUR_PG_CLIENT_SECRET",
"SECUREID_APP_SECRET": "YOUR_SECUREID_CLIENT_SECRET",
"TWO_FA_PUBLIC_KEY_PEM_PATH": "/path/to/public_key.pem"
}
}
}
}The Cashfree MCP Server lets AI tools and agents talk to Cashfree’s Payment Gateway, Payouts, and SecureID APIs using the Model Context Protocol. It provides a programmable bridge so you can perform payments, manage payouts, and verify identities from your MCP-enabled clients.
How to use
You run the MCP server locally (stdio) and connect your MCP client to it. The server exposes the Cashfree APIs you enable with the TOOLS setting. Start the server with Node and point it at the built distribution, then configure your MCP client to load the cashfree mcp server with the appropriate environment credentials. You can set the environment to sandbox for testing or production for live operations. Interactive parameter elicitation can prompt you for missing values if you enable it.
How to install
Prerequisites: ensure you have Node.js installed (version 14.x or higher). If you use a helper tool like nvm or brew, make sure the active Node version meets this requirement.
node -v
# Should output v14.x or higher
Clone the MCP server repository, install dependencies, and build the project.
git clone https://github.com/cashfree/cashfree-mcp.git
cd cashfree-mcp
npm install
npm run build
Start the MCP server using the stdio configuration. The final start command shown below is the runtime command you should use to run the server in your environment.
node /path/to/cashfree-mcp/dist/index.js
Additional configuration and notes
You enable specific Cashfree APIs by listing them in the TOOLS environment variable. For example, to enable Payment Gateway, Payouts, and SecureID, set TOOLS to pg,payouts,secureid. You also need to provide API credentials for each service via environment variables.
Security and credentials
Provide credentials securely through environment variables. The following env vars are used by the MCP server: PAYMENTS_APP_ID, PAYMENTS_APP_SECRET, PAYOUTS_APP_ID, PAYOUTS_APP_SECRET, TWO_FA_PUBLIC_KEY_PEM_PATH, SECUREID_APP_ID, SECUREID_APP_SECRET, ENV, ELICITATION_ENABLED. Use sandbox values for testing and production values for live operation.
Elicitation and interactive mode
If you set ELICITATION_ENABLED to true, the MCP server will prompt you for any required parameters that were not supplied, rather than failing with validation errors. This helps you complete configurations interactively during setup.
Available tools
search
Search across the Cashfree Payments Developer Documentation.
get-input-source-help
Get comprehensive instructions for handling input source variable errors.
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 made against it.
get-orders-for-a-payment-link
View all order details for a payment link.
create-order
Create orders with Cashfree to obtain a payment_sessions_id for transactions.
get-order
Fetch order details by order_id.
get-order-extended
Get extended order data like address, cart, offers, customer details.
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 by Payment ID.
create-refund
Initiate refunds.
get-all-refunds-for-an-order
Fetch all refunds for an order.
get-refund
Fetch a specific refund on your Cashfree account.
get-all-settlements
Get settlement details by ID, UTR, or date range.
get-split-and-settlement-details-by-order-id-v2-0
Get split and settlement details for vendors in an order.
get-settlements-by-order-id
View settlements for 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 a prior order creation.
fetch-simulation
Fetch simulated payment details.
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 at Cashfree Payments.
get-batch-transfer-status-v2
Get the status of a batch transfer.
authorize
Authenticate with Cashfree and obtain a bearer token.
create-cashgram
Create a Cashgram.
deactivate-cashgram
Deactivate a Cashgram.
get-cashgram-status
Get the status of a created Cashgram.
verify-name-match
Verify names with variations in SecureID.
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.