Reporting Overview
Learn about Forage’s three report types and how to access them via Dashboard, API, or SFTP—each suited to different business sizes and technical needs.
Forage offers three types of reports:
- Transaction Report - A detailed list of all transactions within a selected timeframe.
- Payout Report - A summary of payouts processed by Forage.
- Payout Transaction Report - A breakdown of transactions that make up each payout.
Forage offers three ways to access reports, depending on your business needs. Each method provides a different level of automation and detail.
Forage Dashboard
Accessing reports through the Forage Dashboard is best for small businesses or merchants who prefer a simple, manual way to access transaction data.
- Pros: Easy to use, no technical setup required. Ideal for occasional reporting needs.
Dashboard reports offer a single CSV file with your choice of fields, and must be manually requested each time. If you want more automation and data points, use API or SFTP reports.
How to download reports from the Forage Dashboard
Access the Forage Dashboard to generate and download reports.
This method provides a basic list of transaction activities but may lack the detailed insights available in other reporting options.
API Reports (JSON)
Retrieving reports via the Forage API is best for businesses that want more automation but still control when and how they retrieve reports.
- Pros: More automation than manual dashboard downloads. The structured data format (JSON) allows for integration with business systems.
Requires development resources to set up and maintain API requests, but you can automate API report requests at your scheduled time. For fully automated delivery, use SFTP reports.
How to generate reports via API
See Reports in our API Reference to get started with API reporting endpoints.
SFTP Reports (CSV)
Accessing reports via a secure SFTP site is best for large businesses and enterprises that need fully automated, scheduled reporting.
- Pros: Fully automated, requires no ongoing effort. Ideal for high-volume businesses with regular reporting needs. Ensures timely and consistent data delivery.
Requires minimal technical setup and maintenance to verify file transfers and set up initial server access. For a more straightforward occasional solution, consider downloading reports via the Forage Dashboard.
How to receive reports by SFTP
See our detailed guide on SFTP reports, including samples of each report.
Updated about 19 hours ago