v1

latestOpenAPI 3.0.32026-08-0658558.8 KB

Reports

Create report

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.

post/v1/reports

Request body

reportNamestring required

User defined name of the report.

startDatestring date-time required

The ISO-8601 start date (inclusive) for requested report.

endDatestring date-time required

The ISO-8601 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.

Example request

{
  "reportName": "My custom report",
  "startDate": "2018-04-06T19:33:35Z",
  "endDate": "2018-04-06T20:33:35Z"
}

Response

Returns the JSON record for the posted report

reportIdstring uuid required

Unique identifier for a report.

reportNamestring

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.

startDatestring date-time required

The ISO-8601 start date (inclusive) of the report.

endDatestring date-time required

The ISO-8601 end date (inclusive) of the report.

Note: Must be after startDate, but no more than 90 days after.

createdOnstring date-time

Report creation time

Example response

{
  "reportId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "reportName": "My custom report",
  "reportStatus": "READY",
  "startDate": "2018-04-06T19:33:35Z",
  "endDate": "2018-04-06T20:33:35Z",
  "createdOn": "2018-04-06T20:33:35Z"
}