Validates if tenant is enabled for reporting

Reports

Use these API operations to get payment reports.

Operation	Method	Description
List reports	GET	Returns an array of reports available for download.
Create a report	POST	Create a report.
Get a report	GET	Get the download link for a specific report.
Delete a report	DELETE	Delete a specific report.
Download a report	GET	Download a transaction report.

Operations

Scheduler

Operations

InternalReports

Operations

Get Reports

Request

Returns a JSON array of report metadata

Security

Bearer

Query

caspian-onlyboolean

Include Caspian reports in response

created-bystring

Query for report types based on the entity that initiated report creation.

Value	Description
SCHEDULER	Get automated system-generated reports.
USER	Customized reports generated by users through the UI.
API	Customized reports generated using the API.

Enum"USER""SCHEDULER""API"

Example: created-by=USER

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports?caspian-only=true&created-by=USER' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns an array of report metadata for the calling tenant

Bodyapplication/json

reportsArray of objects>= 0 itemsrequired

reportIdstring(uuid)required

Unique identifier for a report.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportNamestring[ 1 .. 256 ] characters

User defined name of the report.

Example: "My custom report"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

reportStatusstringrequired

The status of the report.

Enum Value	Description
PENDING	Report isn't ready for download.
READY	Report is ready for download.
FAILED	Unable generate the report.
EMPTY	Report has no transactions for the date range.

Example: "READY"

startDatestring(date-time)required

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

Example: "2018-04-06T20:33:35Z"

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.

Example: "2018-04-06T20:33:35Z"

createdOnstring(date-time)

Report creation time

Example: "2018-04-06T20:33:35Z"

reportCreatedBystring[ 1 .. 128 ] characters

Identifies the entity that initiated the report creation.

Value	Description
SCHEDULER	Automated system-generated report initiated by the scheduler.
API	User-generated report initiated through the API.
[full name]	Full name of the user who initiated the creation of the report through the UI.
null	Legacy support for older reports.

Example: "Norma Jean"

Response

application/json

{
  "reports": [
    { … }
  ]
}

Update reports

Request

Request regeneration of a list of reports

Security

Bearer

Query

tenant-idstring[ 1 .. 128 ] charactersrequired

id for tenant

use-caspianboolean

Use Caspian flag to use Caspian to generate updated report

Body*/*

List of IDs for report regeneration

Array [

string(uuid)

]

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports?tenant-id=string&use-caspian=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d 497f6eca-6276-4993-bfeb-53cbbbba6f08

Responses

Returns the list of reports with resulting retry STATUS attached

Bodyapplication/json

reportsArray of objects>= 0 itemsrequired

reportIdstring(uuid)required

Unique identifier for a report.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportNamestring[ 1 .. 256 ] characters

User defined name of the report.

Example: "My custom report"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

reportStatusstringrequired

The status of the report.

Enum Value	Description
PENDING	Report isn't ready for download.
READY	Report is ready for download.
FAILED	Unable generate the report.
EMPTY	Report has no transactions for the date range.

Example: "READY"

startDatestring(date-time)required

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

Example: "2018-04-06T19:33:35Z"

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.

Example: "2018-04-06T20:33:35Z"

createdOnstring(date-time)

Report creation time

Example: "2018-04-06T20:33:35Z"

Response

application/json

{
  "reports": [
    { … }
  ]
}

Create report

Request

Request generation of a report

Security

Bearer

Query

use-caspianboolean

Use Caspian flag to use Caspian to generate report

Body*/*

Parameters defining the requested report

reportNamestring[ 1 .. 256 ] charactersrequired

User defined name of the report.

Example: "My custom report"

startDatestring(date-time)required

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

Example: "2018-04-06T19:33:35Z"

endDatestring(date-time)required

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

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

Example: "2018-04-06T20:33:35Z"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

curl -i -X POST \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports?use-caspian=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns the JSON record for the posted report

Bodyapplication/json

reportIdstring(uuid)required

Unique identifier for a report.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportNamestring[ 1 .. 256 ] characters

User defined name of the report.

Example: "My custom report"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

reportStatusstringrequired

The status of the report.

Enum Value	Description
PENDING	Report isn't ready for download.
READY	Report is ready for download.
FAILED	Unable generate the report.
EMPTY	Report has no transactions for the date range.

Example: "READY"

startDatestring(date-time)required

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

Example: "2018-04-06T19:33:35Z"

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.

Example: "2018-04-06T20:33:35Z"

createdOnstring(date-time)

Report creation time

Example: "2018-04-06T20:33:35Z"

Response

application/json

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

Create report

Request

Request generation of a report created by a SCHEDULER job

Security

Bearer

Query

use-caspianboolean

Use Caspian flag to use Caspian to generate report

Body*/*required

Parameters defining the requested report

reportTypeListArray of stringsrequired

Items Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

tenantIdsArray of stringsrequired

Comma-separated tenant IDs.

reportEndpointstringrequired

Enum Value	Description
EXTERNAL	External endpoint
INTERNAL	Internal endpoint

Example: "INTERNAL"

startDatestring(date-time)required

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

Example: "2018-04-06T20:33:35Z"

endDatestring(date-time)required

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

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

Example: "2018-04-06T20:33:35Z"

curl -i -X POST \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/scheduler/reports?use-caspian=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns an array of reports created

Bodyapplication/json

reportsArray of objects>= 0 itemsrequired

reportIdstring(uuid)required

Unique identifier for a report.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportNamestring[ 1 .. 256 ] characters

User defined name of the report.

Example: "My custom report"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

reportStatusstringrequired

The status of the report.

Enum Value	Description
PENDING	Report isn't ready for download.
READY	Report is ready for download.
FAILED	Unable generate the report.
EMPTY	Report has no transactions for the date range.

Example: "READY"

startDatestring(date-time)required

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

Example: "2018-04-06T19:33:35Z"

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.

Example: "2018-04-06T20:33:35Z"

createdOnstring(date-time)

Report creation time

Example: "2018-04-06T20:33:35Z"

Response

application/json

{
  "reports": [
    { … }
  ]
}

Get Report

Request

Returns a single JSON record of report metadata

Security

Bearer

Path

report-idstring(uuid)required

Unique ID for a report

Query

caspian-onlyboolean

Include Caspian reports in response

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports/{report-id}?caspian-only=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Bodyapplication/json

reportIdstring(uuid)required

Unique identifier for a report.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportNamestring[ 1 .. 256 ] characters

User defined name of the report.

Example: "My custom report"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

reportStatusstringrequired

The status of the report.

Enum Value	Description
PENDING	Report isn't ready for download.
READY	Report is ready for download.
FAILED	Unable generate the report.
EMPTY	Report has no transactions for the date range.

Example: "READY"

startDatestring(date-time)required

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

Example: "2018-04-06T19:33:35Z"

endDatestring(date-time)required

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

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

Example: "2018-04-06T20:33:35Z"

createdOnstring(date-time)

Report creation time

Example: "2018-04-06T20:33:35Z"

downloadLinkstring(uri)[ 1 .. 2048 ] characters

Link where you can download the report in the available format. This field is available when the report status is READY.

Example: "https://reporting-test.rnc.ripplenet.com/v4/reports/download/497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportCreatedBystring[ 1 .. 128 ] characters

Identifies the entity that initiated the report creation.

Value	Description
SCHEDULER	Automated system-generated report initiated by the scheduler.
API	User-generated report initiated through the API.
[full name]	Full name of the user who initiated the creation of the report through the UI.
null	Legacy support for older reports.

Example: "Norma Jean"

Response

application/json

{
  "reportId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "reportName": "My custom report",
  "reportType": "PAYMENT_OPS",
  "reportFormat": "CSV",
  "reportStatus": "READY",
  "startDate": "2018-04-06T19:33:35Z",
  "endDate": "2018-04-06T20:33:35Z",
  "createdOn": "2018-04-06T20:33:35Z",
  "downloadLink": "https://reporting-test.rnc.ripplenet.com/v4/reports/download/497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "reportCreatedBy": "Norma Jean"
}

Delete reports

Request

Delete provided report-id for the current tenant

Security

Bearer

Path

report-idstring(uuid)required

Unique ID for a report

Query

caspian_onlyboolean

Include Caspian reports in response

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports/{report-id}?caspian_only=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The resource was successfully deleted.

Get the contents of a report

Request

Get the contents of a report

Security

Bearer

Path

report-idstring(uuid)required

Unique identifier for a report.

Example: 497f6eca-6276-4993-bfeb-53cbbbba6f08

Query

caspian-onlyboolean

Include Caspian reports in response

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports/download/497f6eca-6276-4993-bfeb-53cbbbba6f08?caspian-only=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Bodyapplication/json

string(binary)

Response

application/json

"string"

Delete reports

Request

Delete all reports for all tenants

Security

Bearer

curl -i -X DELETE \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports/all \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The reports were successfully deleted.

Rerun reports for all tenants for specified dates

Request

Returns a JSON array of rerun report metadata

Security

Bearer

Query

use-caspianboolean

Use Caspian flag to use Caspian to generate updated report

Body*/*

Parameters defining the reports to update

startDatestring(date-time)required

Start date for requested reports.

Example: "2018-04-06T19:33:35Z"

endDatestring(date-time)required

End date for requested reports.

Example: "2018-04-06T20:33:35Z"

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports/all?use-caspian=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Returns an array of report metadata for rerun reports

Bodyapplication/json

reportsArray of objects>= 0 itemsrequired

reportIdstring(uuid)required

Unique identifier for a report.

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

reportNamestring[ 1 .. 256 ] characters

User defined name of the report.

Example: "My custom report"

reportTypestringrequired

The report type of the downloadable report.

Value	Description
PAYMENT_OPS	Basic payment report suitable for high-level payment investigation and reporting.

reportFormatstringrequired

The report format of the downloadable report.

Enum Value	Description
CSV	A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
JSON	JSON (Javascript Object Notation) is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.

reportStatusstringrequired

The status of the report.

Enum Value	Description
PENDING	Report isn't ready for download.
READY	Report is ready for download.
FAILED	Unable generate the report.
EMPTY	Report has no transactions for the date range.

Example: "READY"

startDatestring(date-time)required

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

Example: "2018-04-06T19:33:35Z"

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.

Example: "2018-04-06T20:33:35Z"

createdOnstring(date-time)

Report creation time

Example: "2018-04-06T20:33:35Z"

Response

application/json

{
  "reports": [
    { … }
  ]
}

Get Reports list grouped by tenant id

Request

Returns a list of all reports grouped by tenant id. If tenant id is not supplied returns list of all tenants

Security

Bearer

Query

tenant-idsArray of strings

Comma-separated tenant IDs.

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

Responses

Returns the list of reports grouped by tenant id

Bodyapplication/json

property name*Array of objectsadditional property

Response

application/json

{
  "property1": [
    {}
  ],
  "property2": [
    {}
  ]
}

Delete reports

Request

Delete all reports, or singular report if specified, for the tenant provided,

Security

Bearer

Query

tenant-idstring[ 1 .. 128 ] charactersrequired

tenant-id

report-idstring(uuid)required

Unique ID for a report

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/report-service/report-service/internal/reports/tenants?tenant-id=string&report-id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The report(s) were successfully deleted.