Skip to main content

Retrieve reports

There are several ways to retrieve reports so that you can use the option that makes the most sense for you. Methods for retrieving reports include: 

  • Returned via a URL in GET /reports and GET /reports/{report-id}  
  • Sent as CSV or PDF in the payload of GET /report-files/{report-id} 
  • Accessed via our Commerce Center user portal 

Before you begin

Before you can access reports, you’ll need to: 

Reports via URL

Reports can be accessed via the reportDetails.url returned in several Reporting API endpoints.  To retrieve the URL send a request to GET /reports or GET /reports/{report-id}. 

The following shows an example of receiving the reportDetails.url in the Reporting API response. 

HTTP method: GET
Endpoint: /reports

Json
{
    "next": null,
    "summarizedReports": [
        {
            "reportIdentifier": "6ee97665-8d2c-424c-859a-dd98a9e4e0ca",
            "reportConfigurationId": "193544e3-0fdf-472e-8cae-798ff88da609",
            "reportTypeNames": [
                "Settlement Summary",
                "Settlement Details"
            ],
            "reportStatus": "requested",
            "updateTimestamp": "2021-08-23T00:23:05.353Z",
            "createTimestamp": "2021-08-23T00:19:05.353Z",
            "intervalParam": {
                "reportingPeriodStartTimestamp": "2021-08-23 00:18:18",
                "reportingPeriodEndTimestamp": "2021-08-23 00:19:18",
                "scheduleFrequency": "adhoc"
            }
        },
        {
            "reportIdentifier": "c6a6f075-64d5-476f-b463-bc1c5de1abd7",
            "reportConfigurationId": "ca788ad9-521c-45ec-b36d-0fdd38701e4d",
            "reportTypeNames": [
                "Transaction Details"
            ],
            "reportStatus": "completed",
            "updateTimestamp": "2021-08-20T00:23:05.353Z",
            "createTimestamp": "2021-08-20T00:19:05.353Z",
            "intervalParam": {
                "reportingPeriodStartTimestamp": "2021-08-20 00:18:18",
                "reportingPeriodEndTimestamp": "2021-08-20 00:19:18",
                "scheduleFrequency": "adhoc"
            },
            "reportDetails": {
                "reportFileName": "992994469896.Multiple.adhoc.2021-08-20.2021-08-20",
                "url": "https://sample-report-url"
            }
        }
    ],
    "lastPage": true
}
Tip

The GET /reports response uses pagination. Learn more about pagination.

The following shows an example of receiving the reportDetails.url in the Reporting API response. 

HTTP method: GET
Endpoint: /reports/{report-id}

Json
{
    "reportIdentifier": "c6a6f075-64d5-476f-b463-bc1c5de1abd7",
    "reportConfigurationId": "ca788ad9-521c-45ec-b36d-0fdd38701e4d",
    "reportTypeNames": [
        "Settlement Summary",
        "Settlement Details"
    ],
    "reportStatus": "completed",
    "updateTimestamp": "2021-08-20T00:23:05.353Z",
    "createTimestamp": "2021-08-20T00:19:05.353Z",
    "intervalParam": {
        "reportingPeriodStartTimestamp": "2021-08-20 00:18:18",
        "reportingPeriodEndTimestamp": "2021-08-20 00:19:18",
        "scheduleFrequency": "adhoc"
    },
    "reportDetails": {
        "reportFileName": "992994469896.Multiple.adhoc.2021-08-20.2021-08-20",
        "url": "https://helix-data-reporting-files-int.uat.aws.jpmchase.net/api/v1/report-files/c6a6f075-64d5-476f-b463-bc1c5de1abd7"
    }
}

Reports via JSON payload

Reports can be sent as in the payload response to the GET /report-files/{report-id} endpoint.  In this manner, CSV or PDF data is returned within the JSON response. The default setting is CSV. You can also specify a format in reportFormatList in the report configuration. Learn more about managing report configurations. 

  • Send the desired reportIdentifier in the path as report-id. 
  • You can also change the file format by appending ?reportFormat=pdf or ?reportFormat=csv to the request. 
Tip

You may need to GET /reports first to find a list of available reportIdentifiers.

The following shows an example of receiving CSV data within the JSON response. 

HTTP method: GET
Endpoints: /report-files/{report-id} or /report-files/{report-id}?reportFormat=csv

Json
{
    "fileContent": "9876543210.SettlementDetail.Adhoc,2020-11-30.2020-11-30"
}
Tip

The Reporting API doesn't support fixed length. Instead, the report file data is separated by fileDelimiter attribute. For more information, refer Report configuration.

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. 

Attention

Report file size limits for different report delivery options:

  • Commerce Center: up to 500 MB
  • Reporting API: up to 3 GB
  • For reports above 3GB, large file delivery mechanism set up is required.