Reports API
You can use our Reports
API to retrieve the following reconciliation reports:
Authentication
Requests to the /reports
endpoint must be authenticated by providing your access key (OAuth 2.0) or API key in the request's Authorization header.
1--header 'Authorization: Bearer <token>'
Retrieve all reports
Use this endpoint to access all of your reports.
You can also use the following optional query parameters to filter and refine your search query:
Parameter | Description |
---|---|
| Filters reports to those that were created on or after the specified date. The date should be provided in the format: |
| Filters reports to those that were created before the specified date. The date should be provided in the format: |
| Filters reports to those that match the specified client entity ID. Sub-entity IDs are not supported. |
| The number of results to retrieve per page. The maximum value is If the value provided is lower than the total number of results, you'll need to send the response's |
Endpoints
For the full API specification, see the API reference.
https://api.checkout.com/reports
Request example
1curl --location --request GET 'https://api.sandbox.checkout.com/reports?limit=1&created_after=2022-02-14&created_before=2022-02-16&entity_id=ent_zxmc2csd961nfd2mcwzkvdgmpb' \2--header 'Authorization: Bearer sk_sbox_wjvrysklsqjmrhn3yoexnshsl72'
Response example
1{2 "count": 1,3 "limit": 1,4 "data": [5 {6 "id": "rpt_x",7 "created_on": "2022-02-15T02:31:12.357+00:00",8 "type": "FinancialActions",9 "description": "Financial Actions by Date Range",10 "account": {11 "client_id": "cli_123",12 "entity_id": "ent_zxmc2csd961nfd2mcwzkvdgmpb"13 },14 "tags": [],15 "from": "2022-02-14T00:00:00",16 "to": "2022-02-15T00:00:00",17 "files": [18 {19 "id": "file_y",20 "filename": "financialactions_ent_zxmc2csd961nfd2mcwzkvdgmpb_20220214_20220215_1.csv",21 "format": "CSV",22 "_links": {23 "self": {24 "href": "https://api.sandbox.checkout.com/reports/rpt_x/files/file_y"25 }26 }27 }28 ],29 "_links": {30 "self": {31 "href": "https://api.sandbox.checkout.com/reports/rpt_x"32 }33 }34 }35 ],36 "_links": {37 "self": {38 "href": "https://api.sandbox.checkout.com/reports?limit=1&created_after=2022-02-14&created_before=2022-02-16&entity_id=ent_zxmc2csd961nfd2mcwzkvdgmpb"39 },40 "next": {41 "href": "https://api.sandbox.checkout.com/reports?pagination_token=1644892272357&limit=1&created_after=2022-02-14&created_before=2022-02-16&entity_id=ent_zxmc2csd961nfd2mcwzkvdgmpb"42 }43 }44}
If the results for a query are split across multiple pages, the response returns a URL in the _links.next.href
field. You can use this URL in a query to retrieve the next page of results.
Subsequent responses will also include this field, until all results have been returned.
Retrieve a specific report
Use this endpoint to retrieve a specific report, using its ID.
You can find a report's ID in the response you receive when you perform a request to retrieve all reports, in its respective data.id
field.
Endpoints
For the full API specification, see the API reference.
https://api.checkout.com/reports/{reportId}
Request example
1curl --location --request GET 'https://api.sandbox.checkout.com/reports/rpt_x' \2--header 'Authorization: Bearer sk_sbox_wjvrysklsqjmrhn3yoexnshsl72'
Response example
1{2 "id": "rpt_x",3 "created_on": "2022-02-15T02:31:12.357+00:00",4 "type": "FinancialActions",5 "description": "Financial Actions by Date Range",6 "account": {},7 "tags": [],8 "from": "2022-02-14T00:00:00",9 "to": "2022-02-15T00:00:00",10 "files": [11 {12 "id": "file_y",13 "filename": "financialactions_ent_zxmc2csd961nfd2mcwzkvdgmpb_20220214_20220215_1.csv",14 "format": "CSV",15 "_links": {16 "self": {17 "href": "https://api.sandbox.checkout.com/reports/rpt_x/files/file_y"18 }19 }20 }21 ],22 "_links": {23 "self": {24 "href": "https://api.sandbox.checkout.com/reports/rpt_x"25 }26 }27}
Retrieve a file from a report
Use this endpoint to retrieve a specific file from a report, using its ID.
You can find a file's ID in the response you receive when you perform a request to retrieve your reports, in its respective files.id
field.
Endpoints
For the full API specification, see the API reference.
https://api.checkout.com/reports/{reportId}/files/{fileId}
Request example
1curl --location --request GET 'https://api.sandbox.checkout.com/reports/rpt_x/files/file_y' \2--header 'Authorization: Bearer sk_sbox_wjvrysklsqjmrhn3yoexnshsl72'
Response example
Sending the request will trigger a download of the specified file, with no additional response.