View the data fields for the different report types.
Report Service API
The Report Service API provides an efficient and secure way to download On-Demand Liquidity (ODL) payment transactions on the RippleNet network.
Three report types are available in either CSV or JSON format when performing a List reports operation:
| Report type | Description |
|---|---|
PAYMENT_OPS | This is a Basic payment report suitable for high-level payment investigation and reporting. |
RECON | This is a Reconciliation report suitable for reconciliation and detailed state-by-state investigation. |
FAILURE_CONVERSION_SSA | This is a Failure conversion & SSA report suitable for failed payments investigation. |
Note: These On-Demand Liquidity (ODL) statement reports do not include data on fiat payments in RippleNet.
The Basic payment report (PAYMENT_OPS) provides basic payment data, but not the transaction data within payments.
View the Payment operations reports data fields.
The Reconciliation report (RECON) includes all basic payment data, and also includes trade and liquidation data that may be associated with a payment.
A single payment with multiple transactions appears in multiple lines, one line per transaction. Each line includes data that has occurred during the transaction, and all subordinate transactions share the same Payment ID.
View the Reconciliation reports data fields.
The Failure conversion & SSA report (FAILURE_CONVERSION_SSA) includes failed payments data.
Reports are available in pre-generated formats for the previous two months and the current month-to-date.
The month-to-date report is generated daily at 00:00 AM (UTC) and is generally available one minute later, at 00:01 AM.
On October 16th, you can get:
- Full month reports for August and September.
- A month-to-date report from October 1st to October 16th.
| Month | Example | Description |
|---|---|---|
| Current | October 1, 2022 to October 16, 2022 at 00:00 AM | Includes ODL payment data from the first day of the current month up to 00:00 AM (UTC) of the current day. |
| Previous | September (If the current month is October) | Includes all ODL payment data for the month preceding the current month. |
| Month Before Last | August (If the current month is October) | Includes all ODL payment data from the month preceding the last month. |
Use these operations to view a list of reports, or download a specific report.
| API operation | Description |
|---|---|
| List reports | View a list of available reports. |
| Create a report | Create a report. |
| Get a report | View a specific report. |
| Delete a report | Delete a specific report. |
| Download a report | Download an individual report in JSON or CSV format. |
To use any API operation you need a valid access token. You must include a valid access token in the Authorization header of each request.
For more information about getting an access token, see Authentication.
You can use the Report Service API with the test and production environments by using different base URLs.
| Environment | Base URL | Description |
|---|---|---|
| Test | reporting-test.rnc.ripplenet.com | Test environment with simulated partners and simulated currency. |
| Production | reporting.rnc.ripplenet.com | Production environment with actual partners and actual currency. |
Languages
Servers
Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/report_service/reference/openapi/
Test environment<br/>Learn about <a href="https://docs.ripple.com/ripplenet/implementation/baseurls/#base-url-by-api-environment" class="api-console-href">API environments</a>
https://reporting-test.rnc.ripplenet.com/
Production environment
https://reporting.rnc.ripplenet.com/