<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/reports/generate-report -->

# Generate Report

Generate a new report for transactions, payouts, settlements, or other data.

<EndpointHeader verb="POST" path="/merchant/api/v1/reports/generate" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
    { name: "Content-Type", required: true, desc: "`application/json`" },
  ]}
/>

### Body Parameters

<ParamTable
  rows={[
    { name: "type", type: "string", required: true, desc: "Report type: `transactions`, `payouts`, `settlements`, `refunds`, `customers`" },
    { name: "format", type: "string", desc: "Output format: `csv`, `xlsx`, `pdf` (default: `csv`)" },
    { name: "startDate", type: "string", required: true, desc: "Start date (ISO 8601)" },
    { name: "endDate", type: "string", required: true, desc: "End date (ISO 8601)" },
    { name: "filters", type: "object", desc: "Additional filters based on report type" },
    { name: "columns", type: "array", desc: "Specific columns to include" },
  ]}
/>

## Response

### Success (201 Created)

```json
{
  "success": true,
  "data": {
    "id": "rep_550e8400-e29b-41d4-a716-446655440000",
    "merchantId": "mer_xxxxx",
    "type": "transactions",
    "format": "csv",
    "status": "processing",
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-01-31T23:59:59.999Z",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

### Report Status

| Status | Description |
|--------|-------------|
| `pending` | Report queued for processing |
| `processing` | Report is being generated |
| `completed` | Report ready for download |
| `failed` | Report generation failed |

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl -X POST https://api.zenpayz.com/merchant/api/v1/reports/generate \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "transactions",
    "format": "csv",
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-01-31T23:59:59.999Z"
  }'
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
const report = await zenpays.reports.generate({
  type: 'transactions',
  format: 'csv',
  startDate: '2024-01-01T00:00:00.000Z',
  endDate: '2024-01-31T23:59:59.999Z',
});

console.log(report.id); // rep_550e8400...
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [List Reports](/docs/rest-api/endpoints/reports/list-reports)
- [Get Report](/docs/rest-api/endpoints/reports/get-report)
- [Download Report](/docs/rest-api/endpoints/reports/download-report)
