The Report object
Represents a generated or in-progress report. Reports are generated asynchronously. Poll the status until it reaches 'completed' to get the download URL.
Fields
| Field | Type | Description |
|---|---|---|
id REQUIRED | string | Unique identifier for the report |
merchantId REQUIRED | string | ID of the merchant who requested the report |
type REQUIRED | ReportType | Type of report ReportType |
format REQUIRED | ReportFormat | Output format of the report ReportFormat |
status REQUIRED | 'pending'| 'processing'| 'completed'| 'failed' | Current generation status |
downloadUrl OPTIONAL | string | URL to download the report (when completed) |
expiresAt OPTIONAL | string | ISO 8601 timestamp when the download URL expires |
filters OPTIONAL | Record<string, unknown> | Filters that were applied to generate the report |
createdAt REQUIRED | string | ISO 8601 timestamp when the report was requested |
completedAt OPTIONAL | string | ISO 8601 timestamp when the report generation completed |
Example
{
"id": "obj_1a2b3c",
"merchantId": "merchant_1a2b3c",
"type": "transactions",
"format": "csv",
"status": "pending",
"downloadUrl": "string",
"expiresAt": "2026-01-15T09:30:00Z",
"filters": {},
"createdAt": "2026-01-15T09:30:00Z"
}