Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Payment Gateway Merchant Dashboard provides a comprehensive interface for managing your payment operations. Access real-time insights, transaction data, settlement information, and configuration options through an intuitive navigation structure designed for efficient payment management.
1

Log in to the Merchant Dashboard.

Go to the Merchant Dashboard and log in to your Cashfree account. If you don’t have a Cashfree account, sign up for a Cashfree account. Refer to account onboarding, for more information.
2

Access Payment Gateway.

Navigate to Payment Gateway and click Access to proceed to the dashboard.

​
Summary

The Summary section provides essential insights into your payment operations through two key pages:
The Overview page provides a real-time snapshot of your account’s financial health and performance metrics.Key metrics
  • Recent Settled Amount: Displays the latest Offline and Online settled amounts with their respective settlement dates.
  • Open Disputes: Tracks dispute amounts and counts categorised by Action Required and Under Review.
  • Risky Transactions: Monitors fraud data from RiskShield, showing Blocked and Flagged for Review transaction amounts and counts.
Performance chartsVisualises transaction trends over a selected time range, for example, the last 7 days:
  • Total Transactions: Graph showing transaction volume and total amounts over time.
  • Total Refunds: Detailed view of refund amounts and counts.
  • Average Transaction Value: Trend line of the average value per transaction.
  • Preferred Payment Methods: Pie chart distribution of used payment modes, for example, UPI.
The Analytics section offers detailed reports to help you track performance and optimise your payment flows. It is organised into three main tabs:Business trendsAnalyse transaction performance over time with:
  • Success Rate: Graph displaying transaction success percentages filtered by payment modes. For example, Bank Transfer, UPI, Net Banking, Card, or Wallet.
  • Number of Transactions: View total successful transaction counts with comparative insights, for example, compared to last month.
Conversion rateUnderstand your user journey and payment efficiency with:
  • Payment Funnel Report: Bar chart comparing “Number of orders created” versus “Payment attempted” versus “Paid Orders”.
  • Conversion Rate: Visual gauge showing the overall percentage of successful conversions.
  • Customer Insights: Metrics for Unique Customers and Repeat Customers over selected time periods.
  • Auto Retry: Statistics on transactions saved via auto-retry mechanisms, including “Number of Auto Retry Transactions” and “Successful Transactions after Auto Retry”.
Payment failureIdentify and resolve payment issues with:
  • Payment Failure Insight: Timeline graph showing failure rates across different hours or days.
  • Average Payment Failures: Chart highlighting failure sources, for example, Customer or Bank.
  • Top Failure Reasons: Detailed list of failure descriptions, rates, sources, and affected payment modes.
For more information, refer to Analytics.

​
Transactions

The Transactions section provides comprehensive details on all payment activities:
The Payments section displays all payment transactions processed through your Payment Gateway account. Use this section to track, filter, and export payment data for your transactions.Each payment entry includes the following details:
  • Date and Time: When the payment transaction was initiated.
  • Transaction ID: Unique identifier for the payment transaction.
  • Transaction Amt.: Payment amount in Indian Rupees (₹).
  • Payment Method: Payment mode used for the transaction, for example, UPI, NET BANKING, or CREDIT CARD.
  • Status: Current payment state, for example, User Dropped, Success, or Failed.
  • Customer’s Phone No.: Customer’s contact phone number.
  • Order ID: Your system’s unique order identifier.
  • Order Amt.: Original order amount in Indian Rupees (₹).
  • Customer Ref ID: Customer reference identifier from your system.
The Orders section displays all payment orders created through your Payment Gateway account. Each order entry includes the following details:
  • Date and Time: When the order was created.
  • Order ID: Your system’s unique order identifier.
  • Order Amount: Transaction amount in Indian Rupees (₹).
  • CF Order ID: Cashfree generated unique identifier.
  • Order Type: Payment gateway product used.
  • Integration Type: API integration method.
  • Customer Name: Customer who placed the order.
  • Customer Phone: Customer’s contact number.
  • Customer Email: Customer’s email address.
  • Status: Current order state, for example, Expired, Paid, or Pending.
The Refunds section displays all refund transactions processed through your Payment Gateway account. Use this section to track, manage, and export refund data across different refund types.The Refunds page is organised into three tabs:
  • Initiated Refunds: Manually triggered refund transactions.
  • Batch Refunds: Bulk refund operations processed together.
  • Auto Refunds: Automatically processed refunds based on predefined rules.
Each refund entry includes the following details:
  • Date and Time: When the refund was initiated.
  • Order ID: Your system’s unique order identifier.
  • Refund Amt.: Refund amount in Indian Rupees (₹).
  • Order Amt.: Original order amount in Indian Rupees (₹).
  • CF Refund ID: Cashfree generated unique refund identifier.
  • Refund ARN: Acquirer Reference Number for the refund transaction.
  • Payment Mode: Method used for the original payment, for example, NET BANKING or CREDIT CARD.
  • Refund Speed: Processing speed category, for example, Normal.
  • Status: Current refund state, for example, Onhold, Success, or Failed.
The Disputes section displays all payment disputes raised by customers through their banks or payment networks. Use this section to track, manage, and respond to disputes across different status categories.The Disputes page is organised into four tabs:
  • Action Required: Disputes that need immediate attention and response.
  • Under Review: Disputes currently being evaluated by the payment network or bank.
  • Closed: Disputes that have been resolved or finalised.
  • All Disputes: Complete list of all disputes across all statuses.
The Action Required tab displays summary cards that show the urgency and volume of disputes requiring attention:
  • Due Today: Disputes marked as urgent that require response today, with total count and amount.
  • Due Tomorrow: Disputes marked as critical that require response by the next business day, with total count and amount.
  • Insufficient Evidence: Disputes that need additional supporting documentation, with total count and amount.
Each dispute entry includes the following details:
  • Updated On: Date when the dispute was last modified.
  • Created On: Date when the dispute was initiated.
  • Dispute ID: Unique identifier for the dispute case.
  • Order ID: Your system’s unique order identifier.
  • Transaction ID: Unique identifier for the disputed transaction.
  • Type: Dispute category or reason code.
  • Dispute Amt.: Amount being disputed in Indian Rupees (₹).
  • Respond By: Deadline for submitting your response.
  • Action: Available actions you can take on the dispute.
The Suspicious Transactions section displays all payment transactions flagged by the system’s fraud detection mechanisms. Use this section to monitor, investigate, and manage potentially fraudulent or high-risk transactions.Each suspicious transaction entry includes the following details:
  • Created On: Date when the transaction was flagged as suspicious.
  • Order ID: Your system’s unique order identifier.
  • Transaction ID: Unique identifier for the flagged transaction.
  • Suspicious Amt.: Transaction amount flagged as suspicious in Indian Rupees (₹).
  • Case ID: Unique identifier assigned to the fraud investigation case.
  • Status: Current state of the investigation, for example, Under Review, Cleared, or Blocked.

​
Settlements

The Settlements section displays settlement transactions for funds processed through your Payment Gateway account. Use this section to track settlement cycles, view upcoming settlements, and monitor the status of funds being transferred to your bank account.
Track settlements for transactions processed through online payment methods, including verified transactions ready for settlement, transactions currently being processed, and completed settlements with currency details and dates.
Monitor settlements for transactions processed through offline payment methods, with the same level of detail as online settlements including transaction status, processing stages, and completion records.
The online and offline settlement pages display the following summary cards with key information about your funds:
  • Unsettled Amount: Total amount pending settlement, displayed in Indian Rupees (₹). This card also displays your current settlement cycle, the time frame for fund settlement, for example, 2 working days.
  • Upcoming Settlement: Next scheduled settlement amount in Indian Rupees (₹). This card also displays expected settlement by, the date when the next settlement is expected to be processed.
The online and offline settlement sections include the following types:
Regular settlement transactions based on your configured settlement cycle. Each standard settlement entry includes the following details:
  • Initiated At: Date and time when the settlement was initiated.
  • Transaction Period: Date range of transactions included in the settlement.
  • UTR: Unique Transaction Reference number for the bank transfer.
  • Settled Amt.: Settlement amount transferred in Indian Rupees (₹).
  • Status: Current settlement state, for example, Processed, Skipped, or Pending.
Settlement transactions related to vendor or sub-merchant accounts. Each vendor settlement entry includes the following details:
  • Date and Time: When the settlement was initiated.
  • Period: Date range of transactions included in the settlement.
  • Type: Settlement type. AUTOM for automatic settlements or MANUAL for manually initiated settlements.
  • Vendor ID: Unique identifier for the vendor or sub-merchant account.
  • Settlement ID: Unique identifier for the settlement transaction.
  • UTR No.: Unique Transaction Reference number for the bank transfer.
  • Adjustment Amt.: Any adjustment amount applied to the settlement in Indian Rupees (₹).
  • Settled Amt.: Final settlement amount transferred in Indian Rupees (₹).
  • Status: Current settlement state, for example, SUCCESS or FAILED.
  • Failure Reason: Explanation if the settlement failed.
To check dates when settlements are not processed due to bank holidays, select View Settlement Holidays in the upper-right corner.

​
Virtual bank account configuration

The Virtual Bank Account Configuration section manages virtual bank accounts for automated payment reconciliation:
The VBA Accounts section displays all virtual bank accounts associated with your account. Use this section to view, search, and manage your virtual accounts.Each account card displays the following information:
  • Virtual ID: Unique identifier for the account.
  • Name: Name assigned to the virtual account.
  • Status: Current account state, Active or Inactive.
  • A/c: Virtual account number.
  • IFSC: Bank branch IFSC code.
To create a new virtual bank account, select Create VBA Account.
The Notification Groups section allows you to manage teams that receive alerts regarding payments to your Virtual Bank Accounts (VBAs). These groups get notified by WhatsApp and email when payments are received.Manage notification groups
  • View Groups: See all configured notification groups with their assigned names and recipient counts.
  • Create Group: Select Create Notification Group to set up a new alert group.
Group detailsEach notification group card displays:
  • Group Name: Name assigned to the notification group, for example, test_group.
  • Recipients: Number of users in the group receiving notifications.
To create a new notification group, select Create Notification Group.
The Payment Links section enables creation and management of payment requests sent to customers:
The Orders section displays all orders across all payment links. Use this section to track payments and monitor order statuses.Manage orders
  • Filter & Search: Use the date dropdown (for example, Last Month) and Search & Filter to find specific orders.
  • View Options: Adjust the number of rows displayed per page (default is 10).
Order detailsThe table displays the following information for each order:
  • Date & Time: Date and time when the order was created.
  • Order ID: Unique identifier for the order.
  • Transaction ID: Unique identifier for the transaction associated with the order.
  • CF Link ID: Cashfree generated unique link identifier associated with the order.
  • Link ID: Unique identifier for the payment link.
  • Amount: Order amount in Indian Rupees (₹).
  • Phone No.: Customer’s contact number.
  • Email ID: Customer’s email address.
  • Status: Current status of the order, for example, Success, User Dropped.
For more information, refer to Orders.

​
Apps

The Apps section provides access to integrated applications and services that extend your payment gateway functionality.
  • Ecommerce Apps: Install and manage direct integrations with ecommerce platforms like Shopify and Shopify Onsite Card Payments. Use these apps to accept payments directly on your store fronts.
  • Software Vendors: Connect and manage relationships with Independent Software Vendors (ISVs). View available vendors, Connect new partners, or Disconnect existing integrations.
  • Other Apps: Integrate with productivity and communication tools. For example, install the Slack app to receive notifications directly in your team’s communication channels.

​
Customers

The Customers section provides comprehensive insights into your customer base:
Displays customers who have successfully transacted in the selected time range. Each entry includes:
  • Phone No.: Customer’s contact number.
  • Latest Email: Most recent email address used by the customer.
  • Total Spends: Total amount spent by the customer to date.
  • Total Paid Txns: Number of successful transactions completed.
  • Last Transacted At: Date and time of the most recent successful transaction.
  • Preferred Mode: Payment method most frequently used by the customer, for example, UPI or NET_BANKING.
  • Tags: Custom labels assigned to the customer.
Shows customers who initiated a transaction but didn’t make any successful transaction in the selected time range. Each entry includes:
  • Phone No.: Customer’s contact number.
  • Latest Email: Most recent email address provided.
  • Potential Spends: Total value of attempted but incomplete transactions.
  • Total Unpaid Txns: Number of transaction attempts that were not completed.
  • Last Attempted At: Date and time of the most recent transaction attempt.

​
Payment gateway products

Access additional Payment Gateway products that extend your payment capabilities:
Enable faster transactions by saving customer payment information for streamlined repeat purchases. For more information, refer to One Click Checkout.
Automate payment distribution across multiple accounts or vendors for complex payment workflows. For more information, refer to Easy Split.
Generate customized forms for specific customer segments, distributed via WhatsApp, email, and SMS channels. For more information, refer to Payment Forms.
Create embeddable payment buttons for websites and applications with seamless integration capabilities. For more information, refer to Payment Button.
Software Point of Sale solution with Collection Point Management for physical and virtual locations, and Payment Methods configuration for contactless payment acceptance. For more information, refer to SoftPOS.
Advanced payment routing and optimization tools for enhanced transaction processing efficiency. For more information, refer to flowWise.

​
RiskShield

RiskShield provides comprehensive fraud prevention using machine learning technology:
Dashboard summary showing total risky transactions detected, blocked transactions, and overall fraud prevention performance metrics. For more information, refer to RiskShield overview.
Detailed transaction information with risk scores, flagging reasons, and comprehensive analysis for security decision-making. For more information, refer to Risky transactions.
Configure and manage automated rules for suspicious transaction identification, with effectiveness tracking for fraud prevention optimisation. For more information, refer to Smart rules.
Create and manage custom lists of blocked or allowed customers, payment methods, and other parameters. Works with Transactions monitoring. For more information, refer to Blacklists.

​
Reports

The Reports section provides comprehensive reporting tools:
Generate reports by selecting date ranges and report types, then download in preferred formats for immediate analysis and record-keeping. For more information, refer to Download Reports.
Automate report generation and delivery with customizable frequency (daily, weekly, monthly), report types, and delivery preferences. For more information, refer to Schedule Reports.

​
Developers

The Developers section provides technical integration tools and resources:
Generate and manage Application Programming Interface (API) keys required for payment gateway integration with your applications and websites. For more information, refer to authentication.
View detailed logs of all API calls for comprehensive debugging, integration issue resolution, and usage monitoring. For more information, refer to API Logs.
Configure web hook endpoints to receive real-time notifications about payment events, enabling automated workflows and system integration. For more information, refer to Webhooks.
Monitor and manage API rate limits to ensure optimal performance, prevent service disruptions, and maintain system stability. For more information, refer to Rate Limits.
Configure IP allow listing to restrict API access to specific addresses, enhancing security and controlling system access. For more information, refer to Whitelisting.
Access detailed analytics about checkout performance including abandonment rates, completion times, and user behaviour insights. For more information, refer to Checkout Analytics.

​
Downtimes

The Downtimes section monitors payment gateway availability and maintenance schedules:
View current downtimes affecting the payment gateway, categorised by severity levels:
  • High: Critical issues (red indicators).
  • Medium: Moderate impacts (orange indicators).
  • Low: Minor issues (blue indicators).
Monitor planned maintenance and scheduled downtimes for the next two days, helping you prepare for potential service interruptions and plan business operations accordingly.
Access complete downtime history and use filtering options for searches for specific time periods through the View All functionality.