List Detailed Settlement Reports (Legacy)
Use this request to retrieve a list of Detailed Settlement Reports.
Note:
This legacy endpoint supports API-based reporting. For the latest endpoints, see Schedule Detailed Settlement Reports and List Scheduled Detailed Settlement Reports.
To retrieve a list of Detailed Settlement Reports, send a GET request to the following endpoint:
{service_uri}/api/v2/reports/object-storage?report_type=settlement-detailed&month_from={month_from}&month_to={month_to}&status={status}&limit={limit}&offset={offset}
Details
| Detail | Value |
|---|---|
| Endpoint | /api/v2/reports/object-storage/ |
| Method | GET |
Parameters
| Parameter | Description |
|---|---|
report_type | Always set to settlement-detailed. |
month_from | The first month in the selection in yyyy-mm format. |
month_to | The last month in the selection in yyyy-mm format. |
status | The report status: done, processing, or error. |
limit | The number of reports to return. The maximum value is 1,000. |
offset | The pagination offset that defines the starting report position. For example, if there are 11 reports and the offset is 10, the report begins on the tenth report. |
Examples
This example retrieves a list of reports for a specified period.
Request
GET https://{service_uri}/api/v2/reports/object-storage?report_type=settlement-detailed&month_from=2026-01&month_to=2026-01&status=done&limit=10&offset=0
Response
{
"merchant_id": "123456789",
"reports": [
{
"creation_time": "2026-01-15T09:34:25.044Z",
"status_description": "The report is ready.",
"reporting_period": "2026-01",
"tax_region": "US",
"report_id": "{name}.csv",
"report_start_date": "2026-01-15",
"status": "done",
"url": "{service_uri}/api/v2/reports/object-storage/{name}.csv?report_type=settlement-detailed",
"creation_timestamp": "1721381665044",
"report_end_date": "2026-01-15"
},
{
"creation_time": "2026-01-15T09:34:12.165Z",
"status_description": "The report is ready.",
"reporting_period": "2026-01",
"tax_region": "US",
"report_id": "{name}.csv",
"manual": "true",
"report_start_date": "2026-01-15",
"status": "done",
"url": "{service_uri}/api/v2/reports/object-storage/{name}.csv?report_type=settlement-detailed",
"creation_timestamp": "1721381652165",
"report_end_date": "2026-01-15"
}
]
}
Post processing
Use the Download Detailed Settlement Reports request to download a report.
Automated scheduling
You can configure automated scheduling to generate a Detailed Settlement Report on a recurring schedule. For more information, see Schedule Detailed Settlement Reports.
When a scheduled report completes, the service sends a report.complete webhook event. You can use this webhook to receive a completion notification and download the report. For more information, see Vertex Webhooks.
Updated 1 day ago