Report Access and Retrieval

Business Portal

To download specific reports from the portal, follow the steps below:

1. Company Name: Select your company name from the dropdown menu.
2. Program Name: Choose your program name for the report, especially helpful if you have access to multiple programs.
3. Report Name: Select the desired report name.
4. Report Range: Choose the report range (Daily, Weekly, Monthly, or Yearly).
5. Date: Select a specific date or date range based on the report range selected.

Access Data Via API

There are several APIs available to access various types of reports, as well as to request and download them. The following endpoints are provided:

Report Templates

Before requesting reports, you must be aware of all existing reports. The Report Template returns an array of available reports and the names used to create them.

[
    "AccountCreationSummary",
    "AccountholderDetail",
    "ActivityDetail",
    "ActivitySummary",
    "Acquiring",
    "AcquiringChargeback",
    "BulkOrderSummary",
    "CardAuthDetail",
    "CardCreationSummary"...
]

Request Report

Request a report, and the response will provide the report's status along with a reference ID. Each report is cached for 3 days in the Qolo system, linked to its reference ID. To retrieve the most current version of the report, customers must include either the override_flag or overwrite_flag in their request, as both flags function identically.

POST: https://devapi.qolopay.com/api/v1/reports?report_name=ActivityDetail&program_guid={{<YOUR PROGRAM GUIDE>}}&date_from=2025-03-31&date_to=2025-03-31&override_flag=override


Response:
{
    "reference_id": "fb8c725e-8f27-43f1-bb2b-7f91f0055cad",
    "program_guid": "ec426734-8f82-436a-bee3-0048e2b59774",
    "program_name": "Eynod Pooled Trust SANDBOX",
    "status": "Rerun",//rerun status means report is being prepared
    "error": ""
}

Reports should not be downloaded until they reach a 'completed' status. You can subscribe to report webhooks or set up an automated ping to /requestreport to monitor the report's status.

Download Report

Reports can be downloaded once their status is 'complete'. Attempting to download a report before completion may result in a response that does not accurately reflect the requested data.