Retrieve reports using the API
Beta

Last updated: March 25, 2026

You can use the Reports API to retrieve the aggregated reports.

Call the Get all reports endpoint, and provide one or more of the following query parameters:

created_after– Filters results to include only those created on or after a specific date and time.
created_before – Filters results to include only those created before a specific date and time.
entity_id – The entity for which you want to retrieve reports.
limit – The number of results you want to include per page. This defaults to 100 if not specified.
pagination_token – A token that paginates multiple pages of results.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

get

https://{prefix}.api.checkout.com/reports


1{
2  "count": 1,
3  "limit": 5,
4  "data": [
5    {
6      "id": "rpt_lmmldzousk7etoqijqundqexa4",
7      "created_on": "2025-02-18T13:00:12.357Z",
8      "last_modified_on": "2025-02-18T13:16:12.357Z",
9      "type": "Authentication",
10      "description": "Reconciliation Report for X.",
11      "account": {
12        "client_id": "cli_bvaelhppmfiufdnatam37wrfc4",
13        "entity_id": "ent_znj4ih5kn4fuxiaquoudv5mvwy"
14      },
15      "tags": [
16        "payout_id:pay_123456789"
17      ],
18      "from": "2025-02-17T12:00:00Z",
19      "to": "2025-02-18T12:00:00Z",
20      "files": [
21        {
22          "id": "file_7ysmgfkj4ipunduud22uf73iey",
23          "filename": "financial-actions_ent_znj4ih5kn4fuxiaquoudv5mvwy_20250218_000000001drl_1.csv",
24          "format": "CSV",
25          "_links": {
26            "self": {
27              "href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4/files/file_lmmldzousk7etoqijqundqexa4"
28            }
29          }
30        }
31      ],
32      "_links": {
33        "self": {
34          "href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4"
35        }
36      }
37    }
38  ],
39  "_links": {
40    "self": {
41      "href": "https://{prefix}.api.checkout.com/reports?entity_id=ent_znj4ih5kn4fuxiaquoudv5mvwy&created_after=2025-02-17T00:00:00.000Z&limit=5"
42    },
43    "next": {
44      "href": "https://{prefix}.api.checkout.com/reports?pagination_token=NaZMwq3KbreYcXg0dg752Dg8ps4orkwVK9pj9WFzkXk8rPoR32Wf74QWX0EkZ&entity_id=ent_znj4ih5kn4fuxiaquoudv5mvwy&created_after=2025-02-17T00:00:00.000Z&limit=5"
45    }
46  }
47}

Call the Get report details endpoint, and provide the report ID as the {id} path parameter.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

get

https://{prefix}.api.checkout.com/reports/{id}


1{
2  "id": "rpt_lmmldzousk7etoqijqundqexa4",
3  "created_on": "2025-02-18T13:00:12.357Z",
4  "last_modified_on": "2025-02-18T13:16:12.357Z",
5  "type": "Authentication",
6  "description": "Reconciliation Report for X.",
7  "account": {
8    "client_id": "cli_bvaelhppmfiufdnatam37wrfc4",
9    "entity_id": "ent_znj4ih5kn4fuxiaquoudv5mvwy"
10  },
11  "tags": [
12    "payout_id:pay_123456789"
13  ],
14  "from": "2025-02-17T12:00:00Z",
15  "to": "2025-02-18T12:00:00Z",
16  "files": [
17    {
18      "id": "file_7ysmgfkj4ipunduud22uf73iey",
19      "filename": "financial-actions_ent_znj4ih5kn4fuxiaquoudv5mvwy_20250218_000000001drl_1.csv",
20      "format": "CSV",
21      "_links": {
22        "self": {
23          "href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4/files/file_lmmldzousk7etoqijqundqexa4"
24        }
25      }
26    }
27  ],
28  "_links": {
29    "self": {
30      "href": "https://{prefix}.api.checkout.com/reports/rpt_lmmldzousk7etoqijqundqexa4"
31    }
32  }
33}

You can retrieve a specific file from a paginated report. Call the Get report details endpoint, and provide the:

Report ID of a paginated report as the {id} path parameter
Specific file ID from the report as the {fileId} path parameter

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

post

https://{prefix}.api.checkout.com/reports/{id}/files/{fileId}

You are redirected to the report file download location.

Retrieve reports using the API
Beta

Get all reports

Information

Response example

Get report details

Information

Response example

Get report file

Information