Generate file-based reports
Learn how to request and read Forage data in file-based reports
This feature is in active development.
Documentation is subject to change. We appreciate your patience and partnership as we continue to build.
Forage file-based reports detail the previous day’s transactions for a merchant or platform.
Report types
You can request Payout Summary, Payout Transaction, and Transaction reports. See each page below for more information on the report type, including sample data.
Transaction type vs. payment method
Transaction reports now separate the type of transaction from the method of payment (tender). See Understanding Transaction Type and Payment Method for more details.
How to request reports
Forage sends the reports as CSVs to your SFTP or S3 server. Contact your Forage representative to share your server details and set up delivery.
Forage reporting endpoints
In addition to requesting file-based reports, you can programmatically create JSON reports via the Forage Payments API reporting endpoints.
Updated 17 days ago