---
title: "Create report"
method: POST
path: "/v1/reports"
tags: ["Reports"]
---

# Create report

`POST /v1/reports`

Request the generation of a custom report based on the specified parameters.

**Report duration**

Reports can contain up to 90 days of transactions from the previous 9 months.

* Minimum report duration is 1 day.
* Maximum report duration is 90 days.

#### Report retention

Reports are retained for 6 months after the `endDate` specified in your request.  After this period, the report is purged and will no longer be accessible.

## Request body

- ReportRequest
  - `reportName` string, required — User defined name of the report.
  - `startDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) for requested report.
  - `endDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) for a requested report. **Note**: Must be after `startDate`, but no more than 90 days after.
  - `reportType` 'PAYMENT_OPS' | 'RECON' | 'FAILURE_CONVERSION_SSA', required — The report type of the downloadable report.
  - `reportFormat` 'CSV' | 'JSON', required — The report format of the downloadable report.

## Response `200`

Returns the JSON record for the posted report

- ReportRecord
  - `reportId` string, uuid, required — Unique identifier for a report.
  - `reportName` string — User defined name of the report.
  - `reportType` 'PAYMENT_OPS' | 'RECON' | 'FAILURE_CONVERSION_SSA', required — The report type of the downloadable report.
  - `reportFormat` 'CSV' | 'JSON', required — The report format of the downloadable report.
  - `reportStatus` 'PENDING' | 'READY' | 'FAILED' | 'EMPTY', required — The status of the report.
  - `startDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) of the report.
  - `endDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) of the report. **Note**: Must be after `startDate`, but no more than 90 days after.
  - `createdOn` string, date-time — Report creation time

## Other responses

- `400` — Bad Report Request
- `403` — Forbidden

---

[API](https://skmtc.net/ripple/apis/report-service-api.md) · [All operations](https://skmtc.net/ripple/apis/report-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/report-service-api/revisions/54de4d3166be/schema)