Skip to content

Report Service API

Overview
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/

Reports

Use these API operations to get payment reports.

OperationMethodDescription
List reportsGETReturns an array of reports available for download.
Create a reportPOSTCreate a report.
Get a reportGETGet the download link for a specific report.
Delete a reportDELETEDelete a specific report.
Download a reportGETDownload a transaction report.
Operations

Scheduler

Operations

Meta data of the scheduler

Request

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/metadata \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the JSON record for the scheduler job

Bodyapplication/json
object
Response
application/json
{}

Get Scheduler jobs

Request

Returns a JSON array of jobs in the scheduler.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns an array of scheduler jobs.

Bodyapplication/json
jobsArray of objects>= 0 itemsrequired
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobs": [
    { … }
  ]
}

Delete all jobs of provided tenants

Request

Delete all jobs of provided tenants

Security
Bearer
Query
tenant-idsArray of stringsrequired

comma separated tenants ids

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs?tenant-ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The jobs have been successfully deleted.

Response
No content

Delete all jobs of out of scope tenants

Request

Delete all jobs of out of scope tenants

Security
Bearer
curl -i -X DELETE \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/out-of-scope \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The jobs have been successfully deleted.

Response
No content

Creates a new scheduler job

Request

Security
Bearer
Body*/*

Parameters defining the scheduler job

jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/job \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns the JSON record for the posted scheduler job

Bodyapplication/json
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "jobGroup": "string",
  "jobName": "string",
  "jobStatus": "PAUSED",
  "tenantId": "string",
  "jobClassName": "string",
  "cronExpression": "string",
  "description": "string",
  "repeatTime": 0,
  "cronJob": true,
  "priority": 0
}

Creates a new scheduler job

Request

Security
Bearer
Body*/*

Parameters defining the scheduler job

jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/job/trigger \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Success

Body
Response
No content

Updates chron expression for scheduler jobs

Request

Security
Bearer
Body*/*required

Parameters defining the Scheduler Jobs to perform the cron expression update

jobGroupArray of stringsnon-emptyuniquerequired
jobStatusstring[ 1 .. 128 ] characters
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
cronExpressionstring[ 1 .. 128 ] charactersrequired
curl -i -X PUT \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/cron-expression-update \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns an JSON array of updated scheduler jobs.

Bodyapplication/json
jobsArray of objects>= 0 itemsrequired
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobs": [
    { … }
  ]
}

Get Scheduler Job

Request

Returns a single JSON record of SchedulerJob

Security
Bearer
Path
job-idstring(uuid)required

Unique ID for a scheduler job

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/{job-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the JSON record of the SchedulerJob specified in the path parameter

Bodyapplication/json
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "jobGroup": "string",
  "jobName": "string",
  "jobStatus": "PAUSED",
  "tenantId": "string",
  "jobClassName": "string",
  "cronExpression": "string",
  "description": "string",
  "repeatTime": 0,
  "cronJob": true,
  "priority": 0
}

Updates a existing scheduler job

Request

Security
Bearer
Path
job-idstring(uuid)required

Unique ID for a scheduler job

Body*/*

Parameters defining the requested Scheduler Job

jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/{job-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns the JSON record for the updated scheduler job

Bodyapplication/json
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "jobGroup": "string",
  "jobName": "string",
  "jobStatus": "PAUSED",
  "tenantId": "string",
  "jobClassName": "string",
  "cronExpression": "string",
  "description": "string",
  "repeatTime": 0,
  "cronJob": true,
  "priority": 0
}

Delete the scheduler job

Request

Returns a single JSON record of SchedulerJob

Security
Bearer
Path
job-idstring(uuid)required

Unique ID for a scheduler job

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/{job-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The scheduler job was deleted successfully.

Response
No content

Runs the scheduler job

Request

Security
Bearer
Body*/*

Parameters defining the requested Scheduler Job

jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/job-run \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns the JSON record for the scheduler job

Bodyapplication/json
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "jobGroup": "string",
  "jobName": "string",
  "jobStatus": "PAUSED",
  "tenantId": "string",
  "jobClassName": "string",
  "cronExpression": "string",
  "description": "string",
  "repeatTime": 0,
  "cronJob": true,
  "priority": 0
}

Pauses the scheduler job

Request

Security
Bearer
Path
job-idstring(uuid)required

Unique ID for a scheduler job

curl -i -X POST \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/{job-id}/job-pause' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the JSON record for the paused scheduler job

Bodyapplication/json
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "jobGroup": "string",
  "jobName": "string",
  "jobStatus": "PAUSED",
  "tenantId": "string",
  "jobClassName": "string",
  "cronExpression": "string",
  "description": "string",
  "repeatTime": 0,
  "cronJob": true,
  "priority": 0
}

Runs the scheduler job

Request

TBD

Security
Bearer
Path
job-idstring(uuid)required

Unique ID for a scheduler job

curl -i -X POST \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/jobs/{job-id}/job-resumption' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns the JSON record for the paused scheduler job

Bodyapplication/json
jobIdstring(uuid)
jobGroupstring[ 1 .. 128 ] charactersrequired
jobNamestring[ 1 .. 128 ] charactersrequired
jobStatusstring[ 1 .. 128 ] charactersrequired
Enum"PAUSED""RESUMED""SCHEDULED""SCHEDULED_STARTED""EDITED_SCHEDULED"
tenantIdstring[ 1 .. 128 ] charactersrequired
jobClassNamestring[ 1 .. 128 ] charactersrequired
cronExpressionstring[ 1 .. 128 ] charactersrequired
descriptionstring[ 1 .. 128 ] charactersrequired
repeatTimeinteger(int64)required
cronJobbooleanrequired
priorityinteger
Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "jobGroup": "string",
  "jobName": "string",
  "jobStatus": "PAUSED",
  "tenantId": "string",
  "jobClassName": "string",
  "cronExpression": "string",
  "description": "string",
  "repeatTime": 0,
  "cronJob": true,
  "priority": 0
}

InternalReports

Operations