Skip to main content
Cashfree MCP logo
  • Category: model context protocol
  • Auth: DCR_OAUTH
  • Composio-managed OAuth available? No
  • Tools: 38
  • Triggers: 0
  • Slug: CASHFREE_PAYMENTS_MCP
  • Version: 20261030_00

Tools

Slug: CASHFREE_PAYMENTS_MCP_CREATE_ORDERUSE WHEN: The user wants to create a payment order to accept a payment. Requires amount, currency, and customer details. Create a new payment order. Returns order_id and payment_session_id needed to collect payment. NEXT: Call get_order(order_id) to verify the order was created and retrieve the payment session.

Input Parameters

object
required
Request body to create an order at cashfree
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_CREATE_REFUNDUSE WHEN: The user wants to initiate a refund for a payment. Create a refund against an order. Requires order_id and refund details in the body. NEXT: Call get_refund(order_id, refund_id) to track the refund status.

Input Parameters

object
required
create refund request object
string
required
The id which uniquely identifies your order
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_DOWNLOAD_REPORTUSE WHEN: A report has reached DONE status and the user wants the download URL. Download a completed report.

Input Parameters

string
required
Report identifier (must reference a DONE report)
Slug: CASHFREE_PAYMENTS_MCP_FETCH_SIMULATIONUSE WHEN: The user wants to check the result of a simulated payment. Fetch simulated payment details by simulation_id.

Input Parameters

string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
required
Provide the SimulationId for which the details have to be fetched.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_GENERATE_RECON_REPORTUSE WHEN: The user wants to generate a settlement reconciliation report. Generate a settlement reconciliation report asynchronously. NEXT: Call get_report_status(reportId) to poll until the report is DONE, then download_report(reportId).DATE RANGE LIMIT: startDate and endDate must be supplied together and be either a custom range of 31 days or less, or exactly one full financial year — April 1 to March 31 of any financial year that has already begun (the current one may also be requested as April 1 to today). There is no limit on how far back the range starts, but a custom range must not extend into the future. Anything else is rejected with HTTP 400 — split wider custom periods into 31-day chunks.

Input Parameters

string
Comma-separated gateway names (required for Flowwise Recon)
string
Tenant identifier
string
End of date range (YYYY-MM-DD HH:MM:SS). At most 31 days after startDate, unless the pair is a full financial year (April 1 to March 31).
string
Report file name
string
Settlement/payment ID (for adjustment reports)
string
Start of date range (YYYY-MM-DD HH:MM:SS). Required with endDate. Use April 1 for a full financial year.
string
required
Recon report type (settlement_recon_v2, flow_wise_recon_report, offline_settlement_recon)
string
File format (CSV or XLSX)
string
Include offer/promotion data columns
string
Include payment form data columns
Include payment link data columns
string
Include VBA transfer data columns
Slug: CASHFREE_PAYMENTS_MCP_GENERATE_SUMMARY_REPORTUSE WHEN: The user wants to generate a transaction summary, settlement, refund, or ledger report. Generate a summary/download report asynchronously. NEXT: Call get_report_status(reportId) to poll until the report is DONE, then download_report(reportId).DATE RANGE LIMIT: every date pair (startDate/endDate, bbpsStartDate/bbpsEndDate, subscriptionStartDate/subscriptionEndDate) must be either a custom range of 31 days or less, or exactly one full financial year — April 1 to March 31 of any financial year that has already begun (the current one may also be requested as April 1 to today). There is no limit on how far back a range starts, but a custom range must not extend into the future. Anything else is rejected with HTTP 400 — split wider custom periods into 31-day chunks.

Input Parameters

string
Key for custom report types
string
Filter by transaction status
string
Tenant identifier
string
required
End date (YYYY-MM-DD HH:MM:SS). At most 31 days after startDate, unless the pair is a full financial year (April 1 to March 31).
string
Offer ID filter
string
Cashfree form ID
string
Report file name
string
Comma-separated order IDs
string
Internal vendor ID
string
Include no-cost EMI data
string
required
Start date (YYYY-MM-DD HH:MM:SS). Use April 1 for a full financial year.
string
Filter by sub-status
string
required
Report type to generate
string
Template ID for custom report templates
string
BBPS end date (YYYY-MM-DD). Same range limit as startDate/endDate.
string
Generate softPOS-specific report
Filter for payment link transactions
string
Settlement/payout ID
string
BBPS start date (YYYY-MM-DD). Required with bbpsEndDate.
string
File format (CSV or XLSX)
string
Filter by payment status
string
Filter by merchant route ID
string
Include offer data columns
string
Include payment form data columns
Include payment link data columns
string
Include VBA transfer data columns
string
Subscription end date (YYYY-MM-DD). Same range limit as startDate/endDate.
string
Subscription start date (YYYY-MM-DD). Required with subscriptionEndDate.
string
Include merchant order data columns
Slug: CASHFREE_PAYMENTS_MCP_GET_INSTANT_SETTLEMENT_RATESUSE WHEN: The user asks about the charge rate for instant/on-demand settlements. Get instant/on-demand settlement charge rates.

Input Parameters

string
Tenant identifier
Slug: CASHFREE_PAYMENTS_MCP_GET_MERCHANT_FREE_TRIAL_CREDITSUSE WHEN: The user asks about free trial credits for on-demand settlements. Get merchant free trial credits for on-demand settlements.

Input Parameters

string
Tenant identifier
string
Product type. Use OD_SETTLEMENT for on-demand settlement credits
string
Whether this is a free trial context check
Slug: CASHFREE_PAYMENTS_MCP_GET_NEXT_SETTLEMENT_DATEUSE WHEN: The user asks when the next settlement will happen or about settlement schedule. Get the merchant’s next settlement date and holiday information.

Input Parameters

string
Tenant identifier. Pass op for offline/POS merchants.
Slug: CASHFREE_PAYMENTS_MCP_GET_ON_DEMAND_CHARGESUSE WHEN: The user wants to preview charges/fees for an on-demand settlement withdrawal. Calculate exact charges for a specific on-demand withdrawal amount.

Input Parameters

string
Tenant identifier
string
Product type (optional)
number
required
Withdrawal amount to preview charges for (in INR)
boolean
required
Whether this is a free trial withdrawal
Slug: CASHFREE_PAYMENTS_MCP_GET_ON_DEMAND_DAILY_LIMITUSE WHEN: The user asks about on-demand settlement withdrawal limits. Get on-demand settlement maximum daily limit. NEXT: Call get_on_demand_eligible_funds() to see the actual withdrawable amount.

Input Parameters

string
Tenant identifier
Slug: CASHFREE_PAYMENTS_MCP_GET_ON_DEMAND_ELIGIBLE_FUNDSUSE WHEN: The user wants to know how much money can be withdrawn via on-demand settlement. Get eligible funds for on-demand settlement withdrawal. NEXT: Call get_on_demand_charges(requestedAmount, freeTrialRequest=false) to preview fees before withdrawal.

Input Parameters

string
Tenant identifier
string
Product type to check eligibility for
string
Whether this is a free trial eligibility check
Slug: CASHFREE_PAYMENTS_MCP_GET_ON_DEMAND_SETTLEMENT_ACTIVATION_STATUSUSE WHEN: The user asks if on-demand/instant settlements are available or activated. Get on-demand settlement activation status. NEXT: If activated, call get_on_demand_eligible_funds() to check available balance.

Input Parameters

string
Tenant identifier
Slug: CASHFREE_PAYMENTS_MCP_GET_ORDERUSE WHEN: The user wants to check the status of an order or retrieve its payment session details. Fetch order details using the order_id. NEXT: Call get_payments_for_an_order(order_id) to see all payment attempts against this order.

Input Parameters

string
required
The id which uniquely identifies your order
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_GET_ORDER_EXTENDEDUSE WHEN: The user needs extended order information including address, cart items, offers, and customer details. Fetch extended order data using the Cashfree order_id.

Input Parameters

string
required
The id which uniquely identifies your order
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_GET_PAYMENT_BY_IDUSE WHEN: The user wants to view details of a specific payment attempt on an order. Get payment details by order_id and cf_payment_id. NEXT: To refund this payment, call create_refund(order_id, body={refund_amount, refund_id}).

Input Parameters

string
required
The id which uniquely identifies your order
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
required
The Cashfree payment or transaction ID.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_GET_PAYMENT_MODESUSE WHEN: The user wants to filter transactions by payment method but you need the numeric code. Also useful to show what payment methods are available. Retrieve the merchant’s available payment method codes. NEXT: Use the returned code in search_transactions(paymentCode=<code>) to filter by payment method.Returns: Mapping of payment method display names to numeric codes
Slug: CASHFREE_PAYMENTS_MCP_GET_PAYMENTS_FOR_AN_ORDERUSE WHEN: The user wants to see all payment attempts made against a specific order. View all payment details for an order. NEXT: Call get_payment_by_id(order_id, cf_payment_id) to view details of a specific payment.

Input Parameters

string
required
The id which uniquely identifies your order
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_GET_REFUNDUSE WHEN: The user wants to check the status of a specific refund. Fetch a specific refund by order_id and refund_id.

Input Parameters

string
required
The id which uniquely identifies your order
string
required
Refund Id of the refund you want to fetch.
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.
Slug: CASHFREE_PAYMENTS_MCP_GET_REPORT_STATUSUSE WHEN: You need to check if a report is ready for download. Poll this after generate_recon_report or generate_summary_report. Get report status and details (polling endpoint). NEXT: If status is DONE, call download_report(reportId). If REQUESTED or IN_PROGRESS, poll again.

Input Parameters

string
required
Unique report identifier (from _id in generate response)
Slug: CASHFREE_PAYMENTS_MCP_GET_SETTLEMENT_RECON_ROUTESUSE WHEN: The user wants to generate a Flowwise Recon report and you need the gateway route names. Get settlement recon gateway routes. NEXT: Use route names in generate_recon_report(reportType=‘flow_wise_recon_report’, pg=<route_name>).Returns: Array of gateway route objects
Slug: CASHFREE_PAYMENTS_MCP_GET_STANDARD_SETTLEMENT_DETAILSUSE WHEN: The user wants to track where settlement money is in the banking pipeline. Get real-time transfer timeline for specific settlements.

Input Parameters

string
Tenant identifier
string
required
Comma-separated settlement IDs to track
Slug: CASHFREE_PAYMENTS_MCP_GET_TOOL_GUIDEUSE WHEN: You are about to perform a multi-step task and need to know which tools to call and in what order. CALL THIS FIRST before starting any complex task. Returns the recommended tool chain for a user’s intent.Describe the user’s goal in natural language. Examples:
  • “search for failed transactions in the last 7 days”
  • “generate a settlement reconciliation report”
  • “create a payment order for 500 INR”
  • “check the status of a refund”
  • “verify a PAN number” NEXT: Follow the returned step-by-step tool chain to complete the task.

Input Parameters

string
required
Natural language description of what the user wants to do.
Slug: CASHFREE_PAYMENTS_MCP_GET_TRANSACTION_DETAILSUSE WHEN: The user wants to see the full details of a specific transaction including timeline, settlement, and gateway response. View the complete lifecycle of a single transaction.Returns timeline events, order details, customer details, settlement info, gateway response, and optionally EMI and OCC charge breakdowns.

Input Parameters

integer
required
The internal transaction reference ID (refId from search response)
string
Optional tenant identifier for multi-tenant deployments
string
required
Transaction timestamp in YYYY-MM-DD HH:MM:SS format
string
Optional filter for offer/coupon redemption status
Slug: CASHFREE_PAYMENTS_MCP_GET_UNSETTLED_AMOUNTUSE WHEN: The user asks about unsettled balance, money held by Cashfree, or pending settlements. Get the total unsettled amount held by Cashfree. NEXT: Call get_on_demand_eligible_funds() to check how much can be withdrawn immediately, or search_standard_settlements() for history.

Input Parameters

string
Tenant identifier. Pass op for offline/POS merchants.
Slug: CASHFREE_PAYMENTS_MCP_GET_VENDOR_SETTLEMENT_DETAILSUSE WHEN: The user wants to track where vendor settlement money is in the banking pipeline. Get real-time transfer timeline for specific vendor (Easy Split) settlements.

Input Parameters

string
Tenant identifier
string
required
Comma-separated vendor settlement/payout IDs to track
Slug: CASHFREE_PAYMENTS_MCP_LIST_REPORTSUSE WHEN: The user wants to see previously generated reports or check if a report exists. List all previously generated reports for this merchant. NEXT: Call download_report(reportId) to get the download URL for a completed report.DATE RANGE LIMIT: startDate and endDate must be supplied together, span 31 days or less, fall within the last 2 years, and not extend into the future. Wider requests are rejected with HTTP 400 — split them into 31-day chunks. Unlike the generate_* tools, there is no financial-year option here.

Input Parameters

string
Key for custom report types
string
Zero-indexed page number
string
End of date range (YYYY-MM-DD HH:MM:SS). At most 31 days after startDate.
string
Records per page (default 10)
string
Account identifier for multi-account merchants
string
Start of date range (YYYY-MM-DD HH:MM:SS). Required with endDate.
string
Filter by report type
string
Optional list of custom-report filters, each an object with “type” and “key”. Pass them as structured objects — this tool handles JSON/URL encoding for you. Example: [{“type”: “SETTLEMENT”, “key”: “abc”}, {“type”: “TXN”, “key”: “xyz”}]
Slug: CASHFREE_PAYMENTS_MCP_SEARCH_ON_DEMAND_SETTLEMENTSUSE WHEN: The user wants to search past on-demand/instant withdrawal settlements. Search on-demand (instant withdrawal) settlements.DATE RANGE LIMIT: startDate and endDate must be supplied together, span 31 days or less, fall within the last 2 years, and not extend into the future. Wider requests are rejected with HTTP 400 — split them into 31-day chunks.

Input Parameters

string
Search by UTR
string
Zero-indexed page number
string
Tenant identifier
string
End of date range (YYYY-MM-DD). At most 31 days after startDate.
string
Records per page
string
Start of date range (YYYY-MM-DD). Required with endDate.
string
Search by specific on-demand settlement ID
string
Filter by status (SUCCESS, FAILED, PENDING)
Slug: CASHFREE_PAYMENTS_MCP_SEARCH_ORDERSSearch for orders with filters OR fetch a specific order by ID

Input Parameters

string
Zero-indexed page number (0 for first page)
string
Tenant identifier for multi-tenant deployments
string
End of date range (YYYY-MM-DD HH:MM:SS). At most 31 days after startDate.
string
Merchant-assigned order ID
string
Number of records per page (max 100)
string
Cashfree-generated order ID
string
Order type (PRODUCT, POS, PG, CFID, SBC, API)
string
Start of date range (YYYY-MM-DD HH:MM:SS). Required with endDate.
string
Integration type/order source (OCC, softpos, etc.)
string
Order status (PAID, ACTIVE, EXPIRED)
string
Customer name
string
Customer email address
string
Customer phone number
string
Maximum order amount
string
Minimum order amount
string
Set to true for CSV export mode (ignores pagination)
Slug: CASHFREE_PAYMENTS_MCP_SEARCH_PRODUCT_DOCSUSE WHEN: The user asks about Cashfree Developer Documentation product features, API usage, integration guides, or how something works. Searches Cashfree Developer Documentation product documentation and returns matching help articles with titles, content, and links. NEXT: Use the returned content to answer the user’s question directly.

Input Parameters

string
required
Slug: CASHFREE_PAYMENTS_MCP_SEARCH_STANDARD_SETTLEMENTSUSE WHEN: The user wants to search settlement history, check settlement status, or find a specific settlement by UTR. Search standard (scheduled) settlements with filtering and pagination. NEXT: Call get_standard_settlement_details(settlementIds=<id>) to track a specific settlement through the banking pipeline.DATE RANGE LIMIT: startDate and endDate must be supplied together, span 31 days or less, fall within the last 2 years, and not extend into the future. Wider requests are rejected with HTTP 400 — split them into 31-day chunks.

Input Parameters

string
Search by UTR (bank-assigned reference number)
string
Zero-indexed page number
string
Tenant identifier
string
End of date range (YYYY-MM-DD). At most 31 days after startDate.
string
Records per page (max 100)
string
When true, newest settlements first
string
Start of date range (YYYY-MM-DD). Required with endDate.
string
Search by specific settlement ID
string
Filter by type (NORMAL, ON_DEMAND, INSTANT)
string
Filter by status (SUCCESS, FAILED, PENDING, CANCELLED)
string
When true, includes SKIPPED settlements
Slug: CASHFREE_PAYMENTS_MCP_SEARCH_TRANSACTIONSUSE WHEN: The user wants to find, search, filter, or list payment transactions. Search for payment transactions matching the given filters. This is the primary discovery endpoint. NEXT: Call get_transaction_details(txId=<refId>, txTime=<txTime>) to view a specific transaction’s full lifecycle.DATE RANGE LIMIT: startDate and endDate must be supplied together, span 31 days or less, fall within the last 2 years, and not extend into the future. Wider requests are rejected with HTTP 400 — split them into 31-day chunks.

Input Parameters

string
Acquirer Reference Number
string
Bank-assigned RRN (Retrieval Reference Number)
string
Unique Transaction Reference
string
Payment Service Provider
string
Zero-indexed page number
string
Payment gateway identifier
string
Tenant identifier
string
Transaction timestamp (YYYY-MM-DD HH:MM:SS)
string
Cashfree internal transaction ID
string
End of date range (YYYY-MM-DD HH:MM:SS). At most 31 days after startDate.
string
Event identifier
string
Cursor for backward pagination (set to first row’s refId - 1)
string
Cursor for forward pagination (set to last row’s refId)
string
Merchant-assigned order ID
string
Bank name for net banking transactions
string
Number of records per page (request pageSize+1 for pagination check)
string
Payout identifier
string
Merchant-facing refund identifier
string
Transaction status (SUCCESS, PENDING, CANCELLED, etc.)
string
EPOS agent name
string
Cashfree-generated order ID
string
EPOS transaction reference ID
string
Event type
string
Originating platform/channel
string
Start of date range (YYYY-MM-DD HH:MM:SS). Required with endDate.
string
Cashfree-generated refund ID
string
Capture status (1 for captured, 0 for not captured)
string
Whether transaction has been refunded (true/false)
string
Free-text search term
string
EPOS terminal identifier
string
EPOS agent mobile number
string
Maximum transaction amount
string
Numeric payment method code
string
Payment method category (CREDIT_CARD, UPI, NET_BANKING, etc.)
string
Payout status
string
Refund status
string
Customer’s bank (issuing bank)
string
Customer email address
string
Customer phone (merchant-supplied)
string
Minimum transaction amount
string
Cashfree transaction ID
string
Settlement adjustment type
string
Maximum order amount
string
EPOS-specific payment mode
string
Cashfree-verified customer phone
string
Settlement status (SETTLED, NOT_SETTLED, ON_HOLD)
string
Minimum order amount
string
Set to true for CSV export mode (ignores pagination)
string
Merchant-defined customer reference ID
string
Payment verification status
string
Analytics-oriented payment method
string
Sub-type qualifier for paymentMethodAnalytics
Slug: CASHFREE_PAYMENTS_MCP_SEARCH_VENDOR_SETTLEMENTSUSE WHEN: The user wants to search vendor split (Easy Split) settlement payouts. Search vendor split settlement payouts (Easy Split only). NEXT: Call get_vendor_settlement_details(settlementIds=<id>) to track vendor payouts.DATE RANGE LIMIT: startDate and endDate must be supplied together, span 31 days or less, fall within the last 2 years, and not extend into the future. Wider requests are rejected with HTTP 400 — split them into 31-day chunks.

Input Parameters

string
Search by UTR for the vendor payout
string
Zero-indexed page number
string
Filter by status (SUCCESS, FAILED, PENDING, REVERSED, CREATED)
string
Tenant identifier
string
End of date range (YYYY-MM-DD). At most 31 days after startDate.
string
Records per page
string
Search by specific payout/settlement ID
string
Start of date range (YYYY-MM-DD). Required with endDate.
string
Filter by payout type(s)
string
Filter by specific vendor ID
Slug: CASHFREE_PAYMENTS_MCP_SIMULATE_PAYMENTUSE WHEN: The user wants to test/simulate a payment in sandbox mode. Simulate a payment for testing. Create an order first using create_order. NEXT: Call fetch_simulation(simulation_id) to check the simulation result.

Input Parameters

object
required
simulate payment request object
string
Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.
string
API version to be used. Format is in YYYY-MM-DD
string
An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.