- Query the full lifecycle of any transaction by ID.
- Check your unsettled balance and next settlement date in real time.
- Generate and download settlement reconciliation reports using a natural language prompt.
- Evaluate on-demand settlement eligibility and calculate exact withdrawal charges.
- Create payment links directly from your AI client.
- Combine with other MCP-compatible tools such as Gmail, WhatsApp, or GitHub to build end-to-end payment workflows.
Set up the agentic merchant dashboard
Connect to the Cashfree-managed remote MCP server over HTTPS using Claude or ChatGPT. You only need to configure the endpoint URL in your AI client and authenticate using your Cashfree account. Select your AI client to get started.- Claude
- ChatGPT
This integration requires the Claude Desktop application and is not available in the Claude web app. Whether connector access requires a paid plan depends on Anthropic’s current policy. Check your Claude account settings if the connection is blocked.
Open connectors in Claude Desktop
- Log in to the Claude Desktop application.
- In the left navigation, select Customise.
- Select Connectors.
- Select the + icon, then select Add custom connector.
Add the Cashfree connector
- Enter a name for the connector.
-
In the MCP Server URL field, enter the following URL:
- Select Add.
Authenticate with Cashfree
- Select Connect. You are redirected to the Cashfree Merchant Dashboard.
- Log in with the merchant account that should have access.
- Complete the authentication flow and return to Claude Desktop. When the connection is successful, Cashfree tools are available in your Claude session.
Verify your setup
After completing the configuration, follow these steps to confirm the agentic merchant dashboard is working correctly.- Restart your MCP client to apply the configuration.
- Confirm that the Cashfree tools load without errors in your AI client.
- Run a test prompt such as: “Show me the full lifecycle of a recent transaction.” A successful response confirms that the connection is active.
Available tools
The agentic merchant dashboard exposes tools grouped by product area. Use these tools to interact with the Merchant Dashboard and Payment Gateway from your AI agent or development environment.Merchant dashboard tools
Merchant dashboard tools
Use these tools to monitor and manage your merchant account directly from your AI agent. You can search transactions and orders, track settlement timelines, check unsettled balances, calculate on-demand withdrawal charges, and generate or download reconciliation reports, all without opening the Merchant Dashboard.
Transaction tools
The following tools let you query individual transactions, search orders, and retrieve the payment methods available on your account.| Tool name | Description |
|---|---|
get_transaction_details | View the complete lifecycle of a single transaction. |
search_transactions | Search for payment transactions matching given filters. |
search_orders | Search for orders matching given filters. |
get_payment_modes | Retrieve the merchant’s available payment method codes. |
Settlement tools
The following tools cover standard scheduled settlements and on-demand instant withdrawals.| Tool name | Description |
|---|---|
get_unsettled_amount | Get the total unsettled amount held by Cashfree. |
get_next_settlement_date | Get the merchant’s next settlement date and holiday information. |
search_standard_settlements | Search standard (scheduled) settlements with filtering and pagination. |
get_standard_settlement_details | Get the real-time transfer timeline for specific settlements. |
get_on_demand_settlement_activation_status | Get the on-demand settlement activation status. |
get_on_demand_daily_limit | Get the on-demand settlement maximum daily limit. |
get_on_demand_eligible_funds | Get eligible funds for an on-demand settlement withdrawal. |
get_on_demand_charges | Calculate exact charges for a specific on-demand withdrawal amount. |
search_on_demand_settlements | Search on-demand (instant withdrawal) settlements. |
get_instant_settlement_rates | Get instant and on-demand settlement charge rates. |
get_merchant_free_trial_credits | Get merchant free trial credits for on-demand settlements. |
get_settlement_recon_routes | Get settlement reconciliation gateway routes. |
Report tools
The following tools let you generate, check the status of, and download settlement and summary reports.| Tool name | Description |
|---|---|
list_reports | List all previously generated reports for this merchant. |
generate_recon_report | Generate a settlement reconciliation report asynchronously. |
generate_summary_report | Generate a summary or download report asynchronously. |
get_report_status | Get report status and details (polling endpoint). |
download_report | Download a completed report with an auto-shortened URL. |
Payment gateway tools
Payment gateway tools
Use these tools to manage the full payment lifecycle through your AI agent. You can create and cancel payment links, place and retrieve orders, fetch payment details, process refunds, manage settlements, handle disputes, and simulate payments in a sandbox environment.The following table lists all available Payment Gateway tools.
| Tool name | Description |
|---|---|
search | Search across the Cashfree Payments developer documentation. |
create-payment-link | Create a new payment link. |
fetch-payment-link-details | View details and the current status of a payment link. |
cancel-payment-link | Cancel an active payment link. Payments cannot be made after cancellation. |
get-orders-for-a-payment-link | View all orders associated with a payment link. |
create-order | Create an order to obtain a payment_session_id. |
get-order | Fetch details of an order using the order ID. |
get-order-extended | Get additional order data, such as address, cart, and customer details. |
get-eligible-payment-methods | Retrieve available payment methods for a specific order and amount. |
get-payments-for-an-order | View all payment attempts associated with an order. |
get-payment-by-id | View payment details using a payment ID. |
create-refund | Initiate a refund for a payment. |
get-all-refunds-for-an-order | Fetch all refunds processed for an order. |
get-refund | Retrieve details of a specific refund. |
get-all-settlements | Retrieve settlement details using ID, UTR, or a date range. |
get-split-and-settlement-details-by-order-id-v2-0 | Get vendor split and settlement data for an order. |
get-settlements-by-order-id | View all settlement records for a specific order. |
get-disputes-by-order-id | Retrieve all disputes raised for an order. |
get-disputes-by-payment-id | Retrieve all disputes associated with a payment. |
get-disputes-by-dispute-id | Retrieve details of a dispute using its dispute ID. |
accept-dispute-by-dispute-id | Accept a dispute and resolve it in favour of the customer. |
submit-evidence-to-contest-the-dispute-by-dispute-id | Submit supporting documents to contest a dispute. |
simulate-payment | Simulate a payment (requires a valid pre-created order). |
fetch-simulation | Retrieve details of a simulated payment. |
Use cases
The following use cases show how merchants can use the agentic merchant dashboard to handle real operational tasks using natural language, without opening the Cashfree Merchant Dashboard or writing any code.Transaction and order management
The following scenarios show how the agentic merchant dashboard helps you search, trace, and investigate transactions and orders.Trace a failed customer payment instantly
Trace a failed customer payment instantly
A customer contacts your support team reporting that their payment did not go through. Instead of logging in and navigating the dashboard, ask your AI agent: “Show me the full lifecycle of transaction TXN123456.” The agent uses
get_transaction_details to retrieve every state the transaction passed through, including the failure reason, payment mode, and timestamp.Find all failed orders in a date range
Find all failed orders in a date range
Your support team receives multiple complaints after a payment gateway outage. Ask your AI agent: “Find all failed orders between 10 AM and 2 PM today.” The agent uses
search_transactions and search_orders with the relevant filters and returns a list you can act on immediately.Check which payment methods are currently active
Check which payment methods are currently active
Before launching a promotional campaign that offers cashback on UPI payments, ask your AI agent: “What payment methods are available for my account?” The agent uses
get_payment_modes to return the current list of active payment method codes for your merchant account.Settlement and cash flow
The following scenarios show how the agentic merchant dashboard helps you monitor unsettled balances, track settlement timelines, and evaluate on-demand withdrawal options in real time.Check your cash position at the end of the day
Check your cash position at the end of the day
Before closing the books for the day, ask your AI agent: “How much is unsettled right now, and when will it reach my bank?” The agent uses
get_unsettled_amount and get_next_settlement_date to return your current unsettled balance, the next settlement date, and any bank holiday delays.Reconcile last week's settlements
Reconcile last week's settlements
Your finance team needs to verify that all settlements for the previous week matched expected amounts. Ask your AI agent: “Show me all standard settlements from Monday to Friday last week.” The agent uses
search_standard_settlements with a date filter and returns a paginated list. For each settlement, you can follow up with get_standard_settlement_details to see the real-time transfer timeline.Decide whether to withdraw funds on demand
Decide whether to withdraw funds on demand
Your business needs cash urgently before the next scheduled settlement. Ask your AI agent: “How much can I withdraw on demand right now, and what will it cost me to withdraw ₹1,00,000?” The agent uses
get_on_demand_eligible_funds to return available funds and then uses get_on_demand_charges to calculate the exact fee for the amount specified, so you can make an informed decision before initiating a withdrawal.Review on-demand settlement costs before enabling the feature
Review on-demand settlement costs before enabling the feature
Your finance team wants to understand the cost of instant settlements before recommending them to leadership. Ask your AI agent: “What are the current instant settlement rates, and do I have any free trial credits remaining?” The agent uses
get_instant_settlement_rates and get_merchant_free_trial_credits to return both values.Reporting
The following scenarios show how the agentic merchant dashboard helps you generate, track, and download settlement and summary reports using a natural language prompt.Generate a month-end reconciliation report without logging in
Generate a month-end reconciliation report without logging in
At the end of the month, your accounts team needs a full settlement reconciliation report. Ask your AI agent: “Generate a settlement reconciliation report for the month of May.” The agent uses
generate_recon_report to trigger the report, polls get_report_status until it is ready, and then uses download_report to return a download link. No manual steps or dashboard access are required.Download a summary report for a specific date range
Download a summary report for a specific date range
Your operations manager needs a summary of all transactions for a quarterly review. Ask your AI agent: “Generate a summary report for Q1.” The agent uses
generate_summary_report, polls for completion, and returns the download link.List all previously generated reports
List all previously generated reports
Before generating a new report, your team wants to check whether one already exists. Ask your AI agent: “Show me all reports generated in the last 30 days.” The agent uses
list_reports to return the full list with their statuses and generation dates.Payments and collections
The following scenarios show how the agentic merchant dashboard helps you create and manage payment links, process refunds, and handle disputes directly from your AI client.Create a payment link and share it instantly
Create a payment link and share it instantly
Check the status of a payment link
Check the status of a payment link
A customer says they received a payment link but are unsure whether it is still active. Ask your AI agent: “What is the current status of payment link PLK123456? Has it been paid?” The agent uses
fetch-payment-link-details to return the link status, expiry time, and whether a successful payment has been recorded against it.Find all orders placed through a payment link
Find all orders placed through a payment link
After running a sale campaign using a single payment link shared across multiple customers, ask your AI agent: “Show me all orders placed through payment link PLK123456.” The agent uses
get-orders-for-a-payment-link to return every order associated with that link, including order IDs, amounts, and statuses. You can use this to reconcile collections from the campaign.Cancel a payment link before it is used
Cancel a payment link before it is used
A payment link was created with the wrong amount or sent to the wrong customer. Ask your AI agent: “Cancel payment link PLK123456 immediately.” The agent uses
cancel-payment-link to deactivate the link. No further payments can be made against it after cancellation.Investigate a customer dispute about a payment
Investigate a customer dispute about a payment
A customer insists they completed a payment, but your system shows the order as unpaid. Ask your AI agent: “Show me all payment attempts for order ORD789.” The agent uses
get-payments-for-an-order to return every attempt, including status, payment mode, and failure reason, so you can identify whether the payment succeeded, failed, or is pending.Process a refund and track its status
Process a refund and track its status
A customer requests a refund for a returned product. Ask your AI agent: “Initiate a full refund for payment PAY456.” The agent uses
create-refund to submit the refund request. To check progress, ask: “What is the status of the refund for PAY456?” The agent uses get-refund to return the current status and expected credit date.Respond to a chargeback dispute
Respond to a chargeback dispute
Your finance team receives a chargeback for an order the customer claims was not delivered. Ask your AI agent: “Show me all disputes for order ORD321.” The agent uses
get-disputes-by-order-id to retrieve the dispute details. If delivery was confirmed, ask: “Submit evidence to contest dispute DSP001, and attach the delivery confirmation.” The agent uses submit-evidence-to-contest-the-dispute-by-dispute-id to file the response.Test a payment flow in sandbox
Test a payment flow in sandbox
Before going live with a new checkout integration, ask your AI agent: “Simulate a successful UPI payment for order ORD_TEST_001.” The agent uses
simulate-payment to trigger the simulation and fetch-simulation to return the result, so you can verify your integration without processing a real payment.