{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-products/payments-odl/api-docs/report_service/reference/openapi.yaml","sidebar":"sidebar-products/payments-odl/sidebars.yaml"},"props":{"definitionId":"products/payments-odl/api-docs/report_service/reference/openapi.yaml","dynamicMarkdocComponents":[],"baseSlug":"/products/payments-odl/api-docs/report_service/reference/openapi","seo":{"title":"Report Service API","siteUrl":"https://docs.ripple.com/products/custody","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Report Service API","description":"The Report Service API provides an efficient and secure way to download On-Demand Liquidity (ODL) payment transactions on the RippleNet network.\n\n## Report types\n\n Three report types are available in either CSV or JSON format when performing a [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) operation:\n\n | Report type | Description |\n | :--- | :--- |\n | `PAYMENT_OPS` | This is a *Basic payment report* suitable for high-level payment investigation and reporting. |\n | `RECON` | This is a *Reconciliation report* suitable for reconciliation and detailed state-by-state investigation. |\n | `FAILURE_CONVERSION_SSA` | This is a *Failure conversion & SSA report* suitable for failed payments investigation. |\n\n**Note**: These On-Demand Liquidity (ODL) statement reports do not include data on fiat payments in RippleNet.\n\n### Basic payment report\n\nThe Basic payment report (`PAYMENT_OPS`) provides basic payment data, but not the transaction data within payments.\n\nView the [Payment operations reports data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction).\n\n### Reconciliation report\n\nThe Reconciliation report (`RECON`) includes all basic payment data, and also includes trade and liquidation data that may be associated with a payment.\n\nA 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.\n\nView the [Reconciliation reports data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction).\n\n### Failure conversion & SSA report\n\nThe Failure conversion & SSA report (`FAILURE_CONVERSION_SSA`) includes failed payments data.\n \nView the [Failure conversion & SSA report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction).\n \n### Report availability\n\nReports are available in pre-generated formats for the previous two months and the current month-to-date.\n\nThe month-to-date report is generated daily at 00:00 AM (UTC) and is generally available one minute later, at 00:01 AM.\n\n#### Example: Report availability\n\nOn October 16th, you can get:\n * Full month reports for August and September.\n * A month-to-date report from October 1st to October 16th.\n\n| Month | Example | Description |\n| --- | --- | --- |\n| 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. |\n| Previous | September
(If the current month is October) | Includes all ODL payment data for the month preceding the current month. |\n| Month Before Last| August
(If the current month is October) | Includes all ODL payment data from the month preceding the last month. |\n\n\n### API operations\n\nUse these operations to view a list of reports, or download a specific report.\n\n | API operation | Description |\n | --- | --- |\n | [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) | View a list of available reports. |\n | [Create a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport) | Create a report. |\n | [Get a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport) | View a specific report. |\n | [Delete a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport) | Delete a specific report. |\n | [Download a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload) | Download an individual report in JSON or CSV format. |\n\n## Authentication\n\nTo use any API operation you need a valid access token. You must include a valid access token in the `Authorization` header of each request.\n\nFor more information about getting an access token, see [Authentication](/products/payments-odl/api-docs/ripplenet/best-practices/authentication/#request-the-access-token).\n\n### Environments\n\nYou can use the Report Service API with the test and production environments by using different base URLs.\n\n\n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n
EnvironmentBase URLDescription
Testreporting-test.rnc.ripplenet.comTest environment with simulated partners and simulated currency.
Productionreporting.rnc.ripplenet.comProduction environment with actual partners and actual currency.
\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"ripple-product-docs.redocly.app","port":4000,"ipAddress":"216.73.216.152"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main-enterprise-product-docs","PUBLIC_VAR_LQH":"Liquidity Hub","PUBLIC_VAR_LQHUI":"Liquidity Hub UI","PUBLIC_VAR_ODL":"On-Demand Liquidity","PUBLIC_VAR_RN":"RippleNet","PUBLIC_VAR_RNC":"RippleNet Cloud","PUBLIC_VAR_RNSERVER":"RippleNet Server","PUBLIC_VAR_ROSAPINAME":"RippleNet Orchestration","PUBLIC_VAR_RPD":"Ripple Payments Direct","PUBLIC_VAR_SL":"Smart Liquidation","PUBLIC_VAR_SLAPI":"Smart Liquidation API","PUBLIC_VAR_CUS":"Ripple Custody","PUBLIC_VAR_RPO":"RippleNet Payment Object","PUBLIC_VAR_RNH":"Ripple Payments UI","PUBLIC_VAR_RPODL":"Ripple Payments ODL","PUBLIC_VAR_RP":"Ripple Payments","PUBLIC_VAR_RNAPI":"RippleNet Server API","PUBLIC_VAR_RIPPLE_USD":"Ripple USD","PUBLIC_VAR_RLUSD":"RLUSD","PUBLIC_VAR_RS":"Ripple Stablecoin","PUBLIC_VAR_RS_UI":"Ripple Stablecoin UI"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-odl/api-docs/report_service/reference/openapi","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}