Fetch and download a report

To download a report, it must be in the REPORT_AVAILABLE status.

You get the report status with a GET request against the report API.

Request

GET /reports/{id}

Request in API docs

Try yourself with our Postman Collection.

Response

200 - Example response body for payment report in status REPORT_AVAILABLE

{
    "id": "2f49c894-3edd-4835-a8d2-6862bfa42d51",
    "type": "payments",
    "status": "REPORT_AVAILABLE",
    "createdAt": "2023-08-14T11:23:10+00:00",
    "generatedAt": "2023-08-14T11:23:10+00:00"
}

Frequency of requesting a report status

We recommend requesting the report status at a maximum frequency of once per second. The report generation can take a couple of seconds, depending on how much data needs to be processed for it. While the report is generated the report status is REPORT_GENERATING.

Download a report

Once the report status is set REPORT_AVAILABLE you can download it via

GET /reports/{id}/download

Request in API docs

Try yourself with our Postman Collection.

← Previous Request a payments report

Next → Example payments report