# Report Service API ## Security ### Bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Report Service API](https://docs.ripple.com/_bundle/products/payments-direct/api-docs/report-service/report-service.yaml) ## Reports Use these API operations to get payment reports. | Operation | Method | Description | | --- | --- | --- | | [List reports](/products/payments-direct/api-docs/payments-direct-api/reference/payments-direct-api/reports/getreports) | GET | Returns an array of reports available for download. | | [Create a report](/products/payments-direct/api-docs/payments-direct-api/reference/payments-direct-api/reports/postreport) | POST | Create a report. | | [Get a report](/products/payments-direct/api-docs/payments-direct-api/reference/payments-direct-api/reports/getreport) | GET | Get the download link for a specific report. | | [Delete a report](/products/payments-direct/api-docs/payments-direct-api/reference/payments-direct-api/reports/deletereport) | DELETE | Delete a specific report. | | [Download a report](/products/payments-direct/api-docs/payments-direct-api/reference/payments-direct-api/reports/getreportdownload) | GET | Download a transaction report. | ### List reports - [GET /reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/getreports.md): Returns an array of reports available for download. Each array element represents an available report, and contains the reportId, reportType, and reportFormat fields associated with that report. To get the download link for a specific report, store the reportId for the report you want, and use it with the Get a report operation. ### Create report - [POST /reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/postreport.md): 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. ### List reports - [GET /v2/reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/getreportsv2.md): Returns an array of reports generated by Caspian available for download. Each array element represents an available report, and contains the reportId, reportType, and reportFormat fields associated with that report. To get the download link for a specific report, store the reportId for the report you want, and use it with the _Get a report_ operation. ### Create report - [POST /v2/reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/postreportv2.md): Request generation of a report. For Recon Report, Caspian will be used instead of Read Replica ### Get a report - [GET /reports/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/getreport.md): Here, you apply the report-id from the List reports operation as the path parameter to get a downloadlink containing the report. Download the report at the link in the downloadLink field in the response. ### Delete reports - [DELETE /reports/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/deletereport.md): Delete a specific report with the report-id path parameter. ### Get a report - [GET /v2/reports/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/getreportv2.md): Here, you apply the report-id from the _List reports_ operation as the path parameter to get a downloadLink containing the report. Download the report at the link in the downloadLink field in the response. ### Delete reports - [DELETE /v2/reports/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/deletereportv2.md): Delete provided report-id for the current tenant ### Download a report - [GET /reports/download/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/getreportdownload.md): Download a transaction report. Download the report by applying the report-id from the List reports operation as a path parameter. ### Get the contents of a report - [GET /v2/reports/download/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/reports/getreportdownloadv2.md): Get the contents of a report ## Scheduler ### Meta data of the scheduler - [GET /internal/scheduler/metadata](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/getschedulermetadata.md) ### Get Scheduler jobs - [GET /internal/scheduler/jobs](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/getalljobs.md): Returns a JSON array of jobs in the scheduler. ### Delete all jobs of provided tenants - [DELETE /internal/scheduler/jobs](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/deleteschedulerjobs.md): Delete all jobs of provided tenants ### Delete all jobs of out of scope tenants - [DELETE /internal/scheduler/jobs/out-of-scope](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/deleteoutofscopeschedulerjobs.md): Delete all jobs of out of scope tenants ### Creates a new scheduler job - [POST /internal/scheduler/job](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/postjob.md) ### Creates a new scheduler job - [POST /internal/scheduler/job/trigger](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/createjobtrigger.md) ### Updates chron expression for scheduler jobs - [PUT /internal/scheduler/jobs/cron-expression-update](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/updatereportscronexpression.md) ### Get Scheduler Job - [GET /internal/scheduler/jobs/{job-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/getschedulerjob.md): Returns a single JSON record of SchedulerJob ### Updates a existing scheduler job - [PUT /internal/scheduler/jobs/{job-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/updatejob.md) ### Delete the scheduler job - [DELETE /internal/scheduler/jobs/{job-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/deleteschedulerjob.md): Returns a single JSON record of SchedulerJob ### Runs the scheduler job - [POST /internal/scheduler/job-run](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/runjob.md) ### Pauses the scheduler job - [POST /internal/scheduler/jobs/{job-id}/job-pause](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/pausejob.md) ### Runs the scheduler job - [POST /internal/scheduler/jobs/{job-id}/job-resumption](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/scheduler/resumejob.md): TBD ## InternalReports ### Get Reports - [GET /internal/reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalgetreports.md): Returns a JSON array of report metadata ### Update reports - [PUT /internal/reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalputreport.md): Request regeneration of a list of reports ### Create report - [POST /internal/reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalpostreport.md): Request generation of a report ### Create report - [POST /internal/scheduler/reports](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalpostreportasscheduler.md): Request generation of a report created by a SCHEDULER job ### Get Report - [GET /internal/reports/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalgetreport.md): Returns a single JSON record of report metadata ### Delete reports - [DELETE /internal/reports/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internaldeletereport.md): Delete provided report-id for the current tenant ### Get the contents of a report - [GET /internal/reports/download/{report-id}](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalgetreportdownload.md): Get the contents of a report ### Delete reports - [DELETE /internal/reports/all](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/deleteallreports.md): Delete all reports for all tenants ### Rerun reports for all tenants for specified dates - [PUT /internal/reports/all](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalupdatereports.md): Returns a JSON array of rerun report metadata ### Get Reports list grouped by tenant id - [GET /internal/reports/tenants](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/internalgetreportsbytenantid.md): Returns a list of all reports grouped by tenant id. If tenant id is not supplied returns list of all tenants ### Delete reports - [DELETE /internal/reports/tenants](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/deletereportsfortenant.md): Delete all reports, or singular report if specified, for the tenant provided, ### Validates if tenant is enabled for reporting - [GET /internal/validate-tenant](https://docs.ripple.com/products/payments-direct/api-docs/report-service/report-service/internalreports/validatetenant.md)