Retrieve report files
Reporting service provides you with several ways to retrieve report files so that you can choose the option that suits your business needs the most. Methods for retrieving reports include:
- Returned via JSON payload using
GET/report-files/{report-id} - Accessed via our Commerce Center user portal
Before you begin
Before you can access reports, you’ll need to:
- Understand report types
- Set up a new report configuration
- Check the status of your report
Reports via JSON payload
Retrieve reports via the JSON response payload by sending a GET request to the /report-files/{report-id} endpoint.
You can also choose the report data's format by appending ?report-format=PDF or one of the following formats to the request.
| Format type | Description | Output |
|---|---|---|
| The report is generated as a Portable Document Format (PDF). You can have a maximum of 15 fields per section. | File download | |
| CSV | The report is generated in a Comma Seperated Values (CSV) format. | JSON reponse |
| TXT | The report is generated in a textual format. | JSON reponse |
| GZ | The report is generated in a gzip format. Gzip or GNU zip is an open source file compression method. (The maximum compressed file size is 1 GB, which means you can compress upto 16 GB of data) | File download |
The default value report-format is CSV. You can also specify a format in reportFormatList in the report configuration. Learn more about managing report configurations.
The following shows an example of receiving CSV data in the JSON response.
HTTP method: GET
Endpoints: /report-files/{report-id} or /report-files/{report-id}?reportFormat=CSV
{
"fileContent": "9876543210.SettlementDetail.Adhoc,2020-11-30.2020-11-30"
}Reports via Commerce Center
The Commerce Center is a user portal with a wide range of capabilities including viewing your reports and transaction data. For more information on this service, contact your relationship manager or access the user guides under Support in Commerce Center.