{"items":[{"type":"link","label":"Report Service API","link":"/products/payments-odl/api-docs/report_service/reference/openapi","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi","content":{"contentType":"overview","meta":{"name":"Report Service API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Report Service API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Report Service API provides an efficient and secure way to download On-Demand Liquidity (ODL) payment transactions on the RippleNet network."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/report-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Three report types are available in either CSV or JSON format when performing a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_OPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic payment report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suitable for high-level payment investigation and reporting."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECON"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconciliation report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suitable for reconciliation and detailed state-by-state investigation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE_CONVERSION_SSA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure conversion & SSA report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suitable for failed payments investigation."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": These On-Demand Liquidity (ODL) statement reports do not include data on fiat payments in RippleNet."},"children":[]}]}]}]}],"sectionId":"/section/report-types"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/basic-payment-report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic payment report"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Basic payment report ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_OPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") provides basic payment data, but not the transaction data within payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment operations reports data fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/basic-payment-report"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/reconciliation-report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconciliation report"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Reconciliation report ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") includes all basic payment data, and also includes trade and liquidation data that may be associated with a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconciliation reports data fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/reconciliation-report"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/failure-conversion-and-ssa-report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure conversion & SSA report"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Failure conversion & SSA report ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE_CONVERSION_SSA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") includes failed payments data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure conversion & SSA report data fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/failure-conversion-and-ssa-report"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/report-availability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report availability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports are available in pre-generated formats for the previous two months and the current month-to-date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month-to-date report is generated daily at 00:00 AM (UTC) and is generally available one minute later, at 00:01 AM."},"children":[]}]}]}]}],"sectionId":"/section/report-availability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/example:-report-availability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Report availability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On October 16th, you can get:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full month reports for August and September."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A month-to-date report from October 1st to October 16th."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"October 1, 2022 to"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"October 16, 2022 at 00:00 AM"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes ODL payment data from the first day of the current month up to 00:00 AM (UTC) of the current day."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"September"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(If the current month is October)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes all ODL payment data for the month preceding the current month."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month Before Last"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"August"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(If the current month is October)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes all ODL payment data from the month preceding the last month."},"children":[]}]}]}]}]}]}]}],"sectionId":"/section/example:-report-availability"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/api-operations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these operations to view a list of reports, or download a specific report."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List reports"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View a list of available reports."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a report"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View a specific report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a report"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a specific report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download a report"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download an individual report in JSON or CSV format."},"children":[]}]}]}]}]}]}]}],"sectionId":"/section/api-operations"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use any API operation you need a valid access token. You must include a valid access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about getting an access token, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/#request-the-access-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the Report Service API with the test and production environments by using different base URLs."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"table":"","tableLayout":"fixed","width":"100%"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"colgroup","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"col","attrs":{"style":{"width":"15%"}}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"col","attrs":{"style":{"width":"45%"}}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"col","attrs":{"style":{"width":"45%"}}},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Environment"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Base URL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Test"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"reporting-test.rnc.ripplenet.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Test environment with simulated partners and simulated currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"reporting.rnc.ripplenet.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Production environment with actual partners and actual currency."},"children":[]}]}]}]}]}]}],"sectionId":"/section/environments"}]}]}},{"type":"link","label":"Report types","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/report-types","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/report-types","content":null},{"type":"link","label":"Basic payment report","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/basic-payment-report","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/basic-payment-report","content":null},{"type":"link","label":"Reconciliation report","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/reconciliation-report","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/reconciliation-report","content":null},{"type":"link","label":"Failure conversion & SSA report","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/failure-conversion-and-ssa-report","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/failure-conversion-and-ssa-report","content":null},{"type":"link","label":"Report availability","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/report-availability","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/report-availability","content":null},{"type":"link","label":"Example: Report availability","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/example:-report-availability","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/example:-report-availability","content":null},{"type":"link","label":"API operations","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/api-operations","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/api-operations","content":null},{"type":"link","label":"Authentication","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/authentication","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/authentication","content":null},{"type":"link","label":"Environments","link":"/products/payments-odl/api-docs/report_service/reference/openapi/section/environments","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/section/environments","content":null},{"type":"group","label":"Reports","link":"/products/payments-odl/api-docs/report_service/reference/openapi/reports","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/reports","items":[{"label":"List reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports","metadata":{"seo":{"title":"List reports","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReports","name":"List reports","isWebhook":false,"pointer":"/paths/~1v1~1reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an array of reports available for download. Each array element represents an available report, and contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields associated with that report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the download link for a specific report, store the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the report you want, and use it with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created-by","in":"query","schemaId":"schema_0"}],"pointer":"/paths/~1v1~1reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reports","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"created-by","in":"query","required":false,"example":"USER","schemaId":"components/schemas/CreatedByEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/v1/reports","href":"reports/getreports","openApiOperationId":"getReports","summary":"List reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns an array of report metadata for the calling tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsMetadataResponse"}},"schemaId":"components/schemas/ReportsMetadataResponse"},{"code":"400","description":"Bad Report Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1reports/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportsMetadataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsMetadataResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/getreports"}],"panels":[]}]},"httpPath":"/v1/reports"},{"label":"Create report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport","metadata":{"seo":{"title":"Create report","description":"Request the generation of a custom report based on the specified parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postReport","name":"Create report","isWebhook":false,"pointer":"/paths/~1v1~1reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request the generation of a custom report based on the specified parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report duration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports can contain up to 90 days of transactions from the previous 9 months."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum report duration is 1 day."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum report duration is 90 days."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"reports/postreport/request/report-retention","deepLinkHash":"/reports/postreport#reports/postreport/request/report-retention"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report retention"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports are retained for 6 months after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in your request.  After this period, the report is purged and will no longer be accessible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportRequest"}},"schemaId":"components/schemas/ReportRequest","pointer":"/paths/~1v1~1reports/post/requestBody","description":"Parameters defining the requested report"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/reports","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReportRequest"}},"responseCodes":["200","400","403"],"pointer":"/v1/reports","href":"reports/postreport","openApiOperationId":"postReport","summary":"Create report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"schemaId":"components/schemas/ReportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the JSON record for the posted report","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRecord"}},"schemaId":"components/schemas/ReportRecord"},{"code":"400","description":"Bad Report Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1reports/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRecord"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/postreport"}],"panels":[]}]},"httpPath":"/v1/reports"},{"label":"Get a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport","metadata":{"seo":{"title":"Get a report","description":"Here, you apply the report-id from the List reports operation as the path parameter to get a downloadlink containing the report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReport","name":"Get a report","isWebhook":false,"pointer":"/paths/~1v1~1reports~1{report-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here, you apply the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation as the path parameter to get a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadlink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" containing the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the report at the link in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report-id","in":"path","schemaId":"schema_1","description":"Unique identifier for a report.","required":true}],"pointer":"/paths/~1v1~1reports~1{report-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reports/{report-id}","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"parameters":{"path":[{"name":"report-id","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","403","404"],"pointer":"/v1/reports/{report-id}","href":"reports/getreport","openApiOperationId":"getReport","summary":"Get a report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the JSON record of the report specified in the path parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownloadRecordLink"}},"schemaId":"components/schemas/ReportDownloadRecordLink"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1reports~1{report-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportDownloadRecordLink","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownloadRecordLink"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/getreport"}],"panels":[]}]},"httpPath":"/v1/reports/{report-id}"},{"label":"Delete reports","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport","metadata":{"seo":{"title":"Delete reports","description":"Delete a specific report with the report-id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteReport","name":"Delete reports","isWebhook":false,"pointer":"/paths/~1v1~1reports~1{report-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a specific report with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report-id","in":"path","schemaId":"schema_2","description":"Unique ID for a report","required":true}],"pointer":"/paths/~1v1~1reports~1{report-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/reports/{report-id}","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"parameters":{"path":[{"name":"report-id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404","500"],"pointer":"/v1/reports/{report-id}","href":"reports/deletereport","openApiOperationId":"deleteReport","summary":"Delete reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was successfully deleted."},{"code":"404","description":"Reports not found"},{"code":"500","description":"Error while attempting to delete resource"}],"pointer":"/paths/~1v1~1reports~1{report-id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/deletereport"}],"panels":[]}]},"httpPath":"/v1/reports/{report-id}"},{"label":"Download a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload","metadata":{"seo":{"title":"Download a report","description":"Download a transaction report. Download the report by applying the report-id from the List reports operation as a path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportDownload","name":"Download a report","isWebhook":false,"pointer":"/paths/~1v1~1reports~1download~1{report-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download a transaction report. Download the report by applying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation as a path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you specified, the returned report is either a Payment operations report or a Reconciliation report."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report-id","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for a report. Get this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1reports~1download~1{report-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reports/download/{report-id}","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"parameters":{"path":[{"name":"report-id","in":"path","required":true,"example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","403","404"],"pointer":"/v1/reports/download/{report-id}","href":"reports/getreportdownload","openApiOperationId":"getReportDownload","summary":"Download a report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","description":"Mock server","isMockServer":true},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the JSON record of the report specified in the path parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/PaymentOpsReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/ReconReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/FailureConversionSsaReportResponse"]}},"schemaId":"schema_3","exampleIds":["paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/PaymentOpsReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/ReconReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/FailureConversionSsaReportResponse"]},{"code":"204","description":"The contents of the report are empty"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1reports~1download~1{report-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/PaymentOpsReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/ReconReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/FailureConversionSsaReportResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/PaymentOpsReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/ReconReportResponse","paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/FailureConversionSsaReportResponse"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/getreportdownload"}],"panels":[]}]},"httpPath":"/v1/reports/download/{report-id}"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Report Service API provides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_OPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE_CONVERSION_SSA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports in either CSV or JSON format."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/reports","summary":"List reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/getreports","deprecated":false},{"title":"/v1/reports","summary":"Create report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/postreport","deprecated":false},{"title":"/v1/reports/{report-id}","summary":"Get a report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/getreport","deprecated":false},{"title":"/v1/reports/{report-id}","summary":"Delete reports","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/reports/deletereport","deprecated":false},{"title":"/v1/reports/download/{report-id}","summary":"Download a report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/getreportdownload","deprecated":false}]}]}]}]}},{"type":"group","label":"Report data fields","link":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields","items":[{"type":"link","label":"Payment operations","link":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PaymentOpsReportTransaction"},"seo":{"title":"Payment operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment operations","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PaymentOpsReportTransaction"},"children":[]}]}]}},{"type":"link","label":"Reconciliation","link":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ReconciliationReportTransaction"},"seo":{"title":"Reconciliation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reconciliation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ReconciliationReportTransaction"},"children":[]}]}]}},{"type":"link","label":"Failure conversion & SSA","link":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction","routeSlug":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FailureConversionSsaTransaction"},"seo":{"title":"Failure conversion & SSA"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Failure conversion & SSA","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FailureConversionSsaTransaction"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Report data fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report data fields","showPageActions":true},{"nodeType":"markdoc","content":"View the data fields for the different report types."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Payment operations","link":"/report-data-fields/paymentopsreporttransaction","deprecated":false},{"title":"Reconciliation","link":"/report-data-fields/reconciliationreporttransaction","deprecated":false},{"title":"Failure conversion & SSA","link":"/report-data-fields/failureconversionssatransaction","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ReportDownloadRecordLink":{"id":"components/schemas/ReportDownloadRecordLink","kind":"json-schema","title":"ReportDownloadRecordLink","data":{"required":["endDate","reportFormat","reportId","startDate","reportStatus","reportType"],"type":"object","additionalProperties":false,"properties":{"reportId":{"type":"string","description":"Unique identifier for a report.","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","format":"uuid"},"reportName":{"$ref":"#/components/schemas/report_name"},"reportType":{"$ref":"#/components/schemas/ReportTypeEnum"},"reportFormat":{"$ref":"#/components/schemas/ReportFormatEnum"},"reportStatus":{"$ref":"#/components/schemas/ReportStatusEnum"},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start date (inclusive) for a requested report."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T19:33:35Z"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end date (inclusive) for a requested report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but no more than 90 days after."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"},"createdOn":{"$ref":"#/components/schemas/report_created_on"},"downloadLink":{"type":"string","minLength":1,"maxLength":2048,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link where you can download the report in the available format. This field is available when the report "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"uri","example":"https://reporting-test.rnc.ripplenet.com/v1/reports/download/497f6eca-6276-4993-bfeb-53cbbbba6f08"},"reportCreatedBy":{"$ref":"#/components/schemas/ReportCreatedBy"}}}},"components/schemas/ReportRecord":{"id":"components/schemas/ReportRecord","kind":"json-schema","title":"ReportRecord","data":{"required":["endDate","reportFormat","reportId","startDate","reportStatus","reportType"],"type":"object","additionalProperties":false,"properties":{"reportId":{"type":"string","description":"Unique identifier for a report.","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","format":"uuid"},"reportName":{"$ref":"#/components/schemas/report_name"},"reportType":{"$ref":"#/components/schemas/ReportTypeEnum"},"reportFormat":{"$ref":"#/components/schemas/ReportFormatEnum"},"reportStatus":{"$ref":"#/components/schemas/ReportStatusEnum"},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start date (inclusive) of the report."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T19:33:35Z"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end date (inclusive) of the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but no more than 90 days after."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"},"createdOn":{"$ref":"#/components/schemas/report_created_on"}}}},"components/schemas/ReportMetadata":{"id":"components/schemas/ReportMetadata","kind":"json-schema","title":"ReportMetadata","data":{"required":["endDate","reportFormat","reportId","startDate","reportStatus","reportType"],"type":"object","additionalProperties":false,"properties":{"reportId":{"type":"string","description":"Unique identifier for a report.","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","format":"uuid"},"reportName":{"$ref":"#/components/schemas/report_name"},"reportType":{"$ref":"#/components/schemas/ReportTypeEnum"},"reportFormat":{"$ref":"#/components/schemas/ReportFormatEnum"},"reportStatus":{"$ref":"#/components/schemas/ReportStatusEnum"},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start date (inclusive) of the report."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end date (inclusive) of the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but no more than 90 days after."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"},"createdOn":{"$ref":"#/components/schemas/report_created_on"},"reportCreatedBy":{"$ref":"#/components/schemas/ReportCreatedBy"}}}},"components/schemas/ReportsResponse":{"id":"components/schemas/ReportsResponse","kind":"json-schema","title":"ReportsResponse","data":{"required":["reports"],"type":"object","additionalProperties":false,"properties":{"reports":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/ReportRecord"}}}}},"components/schemas/ReportsMetadataResponse":{"id":"components/schemas/ReportsMetadataResponse","kind":"json-schema","title":"ReportsMetadataResponse","data":{"required":["reports"],"type":"object","additionalProperties":false,"properties":{"reports":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/ReportMetadata"}}}}},"components/schemas/ReportRequest":{"id":"components/schemas/ReportRequest","kind":"json-schema","title":"ReportRequest","data":{"required":["reportName","reportType","reportFormat","startDate","endDate"],"type":"object","additionalProperties":false,"properties":{"reportName":{"$ref":"#/components/schemas/report_name"},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start date (inclusive) for requested report."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T19:33:35Z"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end date (inclusive) for a requested report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but no more than 90 days after."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"},"reportType":{"$ref":"#/components/schemas/ReportTypeEnum"},"reportFormat":{"$ref":"#/components/schemas/ReportFormatEnum"}}}},"components/schemas/InternalReportUpdateRequest":{"id":"components/schemas/InternalReportUpdateRequest","kind":"json-schema","title":"InternalReportUpdateRequest","data":{"required":["startDate","endDate"],"type":"object","additionalProperties":false,"properties":{"startDate":{"type":"string","description":"Start date for requested reports.","format":"date-time","example":"2018-04-06T19:33:35Z"},"endDate":{"type":"string","description":"End date for requested reports.","format":"date-time","example":"2018-04-06T20:33:35Z"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"required":["type","errorCode","title","time"],"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","format":"uri","example":"https://docs.ripple.com/payments-odl/api-docs/report_service/reference/#error/RPT_1"},"errorCode":{"type":"string","example":"RPT_1"},"title":{"type":"string","minLength":1,"maxLength":128,"example":"BAD_REQUEST"},"detail":{"type":"string","minLength":1,"maxLength":2048,"example":"Required field missing"},"time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error timestamp."},"children":[]}]}]}],"format":"date-time","example":"2018-04-06T20:33:35Z"}}}},"components/schemas/report_name":{"id":"components/schemas/report_name","kind":"json-schema","title":"report_name","data":{"type":"string","minLength":1,"maxLength":256,"description":"User defined name of the report.","example":"My custom report"}},"components/schemas/report_created_on":{"id":"components/schemas/report_created_on","kind":"json-schema","title":"report_created_on","data":{"type":"string","description":"Report creation time","format":"date-time","example":"2018-04-06T20:33:35Z"}},"components/schemas/end_to_end_id":{"id":"components/schemas/end_to_end_id","kind":"json-schema","title":"end_to_end_id","data":{"type":"string","minLength":1,"maxLength":128,"description":"The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment."}},"components/schemas/ripplenet_payment_id":{"id":"components/schemas/ripplenet_payment_id","kind":"json-schema","title":"ripplenet_payment_id","data":{"type":"string","minLength":1,"maxLength":128,"description":"The unique payment identifier.","example":"70eccd4f-abcd-1234-a655-3aeddff19e4a"}},"components/schemas/fx_spot_rate":{"id":"components/schemas/fx_spot_rate","kind":"json-schema","title":"fx_spot_rate","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source."},"children":[]}]}]}],"example":58.70956379}},"components/schemas/received_amount":{"id":"components/schemas/received_amount","kind":"json-schema","title":"received_amount","data":{"type":"number","description":"The payment amount received by the beneficiary.","example":39.45}},"components/schemas/received_currency":{"id":"components/schemas/received_currency","kind":"json-schema","title":"received_currency","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PHP"}},"components/schemas/sent_amount":{"id":"components/schemas/sent_amount","kind":"json-schema","title":"sent_amount","data":{"type":"number","description":"The payment amount sent.","example":40}},"components/schemas/sent_currency":{"id":"components/schemas/sent_currency","kind":"json-schema","title":"sent_currency","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code of the of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"USD"}},"components/schemas/destination_exchange":{"id":"components/schemas/destination_exchange","kind":"json-schema","title":"destination_exchange","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination exchange for the payment."},"children":[]}]}]}],"example":"independentreserve"}},"components/schemas/source_exchange":{"id":"components/schemas/source_exchange","kind":"json-schema","title":"source_exchange","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source exchange where the sender originates the payment."},"children":[]}]}]}],"example":"bitstamp"}},"components/schemas/receiver_address":{"id":"components/schemas/receiver_address","kind":"json-schema","title":"receiver_address","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"new_york@rn.us.ny.new_york"}},"components/schemas/receiver_customer":{"id":"components/schemas/receiver_customer","kind":"json-schema","title":"receiver_customer","data":{"type":"string","minLength":1,"maxLength":128,"description":"Name of the receiving institution.","example":"sf"}},"components/schemas/sender_address":{"id":"components/schemas/sender_address","kind":"json-schema","title":"sender_address","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"new_york@rn.us.ny.new_york"}},"components/schemas/sender_customer":{"id":"components/schemas/sender_customer","kind":"json-schema","title":"sender_customer","data":{"type":"string","minLength":1,"maxLength":128,"description":"The name of the sending institution.","example":"examplecorp_sf"}},"components/schemas/payment_method":{"id":"components/schemas/payment_method","kind":"json-schema","title":"payment_method","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSM_ID_IDR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MSISDN_ID_IDR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASHPICKUP_ID_IDR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CARD_CN_CNY"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Or you can use RippleNet payment method values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REAL_TIME_GROSS_SETTLEMENT_SYSTEM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REAL_TIME_NET_SETTLEMENT_SYSTEM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MASS_NET_PAYMENT_SYSTEM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BOOK_TRANSFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASH_PAYOUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WALLET_PAYMENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER"},"children":[]}]}]}]}],"example":"CSM_TH_THB"}},"components/schemas/payment_state":{"id":"components/schemas/payment_state","kind":"json-schema","title":"payment_state","data":{"type":"string","minLength":1,"maxLength":128,"description":"The state of a payment at the moment it is queried.","example":"COMPLETED"}},"components/schemas/internal_payment_state":{"id":"components/schemas/internal_payment_state","kind":"json-schema","title":"internal_payment_state","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Ripple internal]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ripple uses this information for troubleshooting purposes."},"children":[]}]}]}],"example":"DONE"}},"components/schemas/remitter_name":{"id":"components/schemas/remitter_name","kind":"json-schema","title":"remitter_name","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete name of the person originating the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Values are only viewable by the customer requesting the report."},"children":[]}]}]}]}},"components/schemas/remitter_account":{"id":"components/schemas/remitter_account","kind":"json-schema","title":"remitter_account","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number at the sending institution for the payment remitter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Values are only viewable by the customer requesting the report."},"children":[]}]}]}]}},"components/schemas/beneficiary_name":{"id":"components/schemas/beneficiary_name","kind":"json-schema","title":"beneficiary_name","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete name of the person receiving the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Values are only viewable by the customer requesting the report."},"children":[]}]}]}]}},"components/schemas/beneficiary_account":{"id":"components/schemas/beneficiary_account","kind":"json-schema","title":"beneficiary_account","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number at the receiving institution for the payment beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Values are only viewable by the customer requesting the report."},"children":[]}]}]}]}},"components/schemas/transaction_id":{"id":"components/schemas/transaction_id","kind":"json-schema","title":"transaction_id","data":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of the balance change between two accounts.","example":"a557eb2d-abcd-1234-a9a0-fdb5b52aaa02"}},"components/schemas/transaction_state":{"id":"components/schemas/transaction_state","kind":"json-schema","title":"transaction_state","data":{"type":"string","minLength":1,"maxLength":128,"description":"The transaction state of the overall payment when it's queried.\n","x-enumDescriptions":{"COMPLETED":"Transaction is complete.","EXECUTED":"Transaction has executed.","FAILED":"Transaction has failed."},"example":"COMPLETE"}},"components/schemas/transaction_type":{"id":"components/schemas/transaction_type","kind":"json-schema","title":"transaction_type","data":{"type":"string","minLength":1,"maxLength":128,"description":"The type of transaction.\n","x-enumDescriptions":{"CRYPTO_TRANSFER":"Transfer of digital assets.","FIAT_TRANSFER":"Transfers of fiat.","TRADE":"Trade transfers."},"example":"TRADE"}},"components/schemas/venue_id":{"id":"components/schemas/venue_id","kind":"json-schema","title":"venue_id","data":{"type":"string","minLength":1,"maxLength":128,"description":"The unique identifier associated with a transaction involving an exchange account. Sometimes it's called \"exchange id\" or \"order id\".","example":"8eef087a-abcd-1234-922d-e802b1126ea0"}},"components/schemas/source_result_amount":{"id":"components/schemas/source_result_amount","kind":"json-schema","title":"source_result_amount","data":{"type":"number","description":"Fiat amount before deduction of source exchange fee."}},"components/schemas/source_result_adjusted_amount":{"id":"components/schemas/source_result_adjusted_amount","kind":"json-schema","title":"source_result_adjusted_amount","data":{"type":"number","description":"Fiat amount after deduction of source exchange fee."}},"components/schemas/source_result_proceeds":{"id":"components/schemas/source_result_proceeds","kind":"json-schema","title":"source_result_proceeds","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XRP amount after exchange of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_result_adjusted_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/source_result_adjusted_proceeds":{"id":"components/schemas/source_result_adjusted_proceeds","kind":"json-schema","title":"source_result_adjusted_proceeds","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XRP amount after deduction of the conversion fees from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_result_proceeds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/withdrawal_result_amount":{"id":"components/schemas/withdrawal_result_amount","kind":"json-schema","title":"withdrawal_result_amount","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final amount of XRP at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wallet to be withdrawn after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal_result_fee_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal_result_incentive_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" incentives have been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This value can be higher or lower than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_result_proceeds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on whether the incentives were positive or negative."},"children":[]}]}]}],"example":39.846668}},"components/schemas/withdrawal_result_fee_amount":{"id":"components/schemas/withdrawal_result_fee_amount","kind":"json-schema","title":"withdrawal_result_fee_amount","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Withdrawal fee charged by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is substracted from the total "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal_result_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/withdrawal_result_incentive_value":{"id":"components/schemas/withdrawal_result_incentive_value","kind":"json-schema","title":"withdrawal_result_incentive_value","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The incentive value in XRP applied to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_result_proceeds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to arrive at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal_result_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]}},"components/schemas/withdrawal_result_id":{"id":"components/schemas/withdrawal_result_id","kind":"json-schema","title":"withdrawal_result_id","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the withdrawal transaction at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2b325317-abcd-1234-9aa2-0d5eb2c3c0e1"}},"components/schemas/deposit_result_id":{"id":"components/schemas/deposit_result_id","kind":"json-schema","title":"deposit_result_id","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the deposit at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"18700e69-1234-abcd-5678-cb17d5ccdbca"}},"components/schemas/deposit_result_amount":{"id":"components/schemas/deposit_result_amount","kind":"json-schema","title":"deposit_result_amount","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of XRP deposited into the destination wallet. Must equal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal_result_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", minus negligible ledger fees."},"children":[]}]}]}]}},"components/schemas/deposit_result_fee_amount":{"id":"components/schemas/deposit_result_fee_amount","kind":"json-schema","title":"deposit_result_fee_amount","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit fee charged in XRP by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/balance_change_currency":{"id":"components/schemas/balance_change_currency","kind":"json-schema","title":"balance_change_currency","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency code associated with the transaction account."},"children":[]}]}]}],"example":"usd"}},"components/schemas/balance_change":{"id":"components/schemas/balance_change","kind":"json-schema","title":"balance_change","data":{"type":"number","description":"The change in account balance caused by the corresponding transaction."}},"components/schemas/balance_result":{"id":"components/schemas/balance_result","kind":"json-schema","title":"balance_result","data":{"type":"number","description":"Account balance after the transaction."}},"components/schemas/destination_result_amount":{"id":"components/schemas/destination_result_amount","kind":"json-schema","title":"destination_result_amount","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final XRP amount at destination wallet to be liquidated into received fiat currency."},"children":[]}]}]}]}},"components/schemas/destination_result_adjusted_amount":{"id":"components/schemas/destination_result_adjusted_amount","kind":"json-schema","title":"destination_result_adjusted_amount","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final XRP amount at destination wallet to be liquidated including fees."},"children":[]}]}]}]}},"components/schemas/destination_result_incentive_value":{"id":"components/schemas/destination_result_incentive_value","kind":"json-schema","title":"destination_result_incentive_value","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The incentive value (XRP) to be added into the total "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination_result_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/destination_result_proceeds":{"id":"components/schemas/destination_result_proceeds","kind":"json-schema","title":"destination_result_proceeds","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Receiver only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of fiat currency received for payout without fee."},"children":[]}]}]}]}},"components/schemas/destination_result_adjusted_proceeds":{"id":"components/schemas/destination_result_adjusted_proceeds","kind":"json-schema","title":"destination_result_adjusted_proceeds","data":{"type":"number","description":"Amount of fiat currency received for payout including fees."}},"components/schemas/execution_result_type":{"id":"components/schemas/execution_result_type","kind":"json-schema","title":"execution_result_type","data":{"type":"string","description":"The type of failure conversion transaction.","minLength":1,"maxLength":128}},"components/schemas/fx_rate":{"id":"components/schemas/fx_rate","kind":"json-schema","title":"fx_rate","data":{"type":"number","description":"The foreign exchange rate associated with the failure conversion transaction."}},"components/schemas/intermediary_delta":{"id":"components/schemas/intermediary_delta","kind":"json-schema","title":"intermediary_delta","data":{"type":"number"}},"components/schemas/transfer_currency":{"id":"components/schemas/transfer_currency","kind":"json-schema","title":"transfer_currency","data":{"type":"string","description":"The three-letter code of the currency associated with this transfer.","minLength":1,"maxLength":128}},"components/schemas/liquidation_status":{"id":"components/schemas/liquidation_status","kind":"json-schema","title":"liquidation_status","data":{"type":"string","minLength":1,"maxLength":128,"description":"Reserved for future use."}},"components/schemas/liquidation_trade_request_status":{"id":"components/schemas/liquidation_trade_request_status","kind":"json-schema","title":"liquidation_trade_request_status","data":{"type":"string","minLength":1,"maxLength":128,"description":"Reserved for future use."}},"components/schemas/payment_batch_id":{"id":"components/schemas/payment_batch_id","kind":"json-schema","title":"payment_batch_id","data":{"type":"string","minLength":1,"maxLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for a batch of payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This field is only populated for payments that are part of a batch."},"children":[]}]}]}]}},"components/schemas/ssa_remote_transfer_id":{"id":"components/schemas/ssa_remote_transfer_id","kind":"json-schema","title":"ssa_remote_transfer_id","data":{"type":"string","description":"The unique identifier of the SSA transfer from the SSA funding account to the SSA account.","minLength":1,"maxLength":128}},"components/schemas/ssa_transfer_amount":{"id":"components/schemas/ssa_transfer_amount","kind":"json-schema","title":"ssa_transfer_amount","data":{"type":"number","description":"The SSA transfer amount."}},"components/schemas/ssa_balance_change":{"id":"components/schemas/ssa_balance_change","kind":"json-schema","title":"ssa_balance_change","data":{"type":"number","description":"The change in SSA balance caused by the corresponding transaction."}},"components/schemas/ssa_balance_result":{"id":"components/schemas/ssa_balance_result","kind":"json-schema","title":"ssa_balance_result","data":{"type":"number","description":"The SSA account balance after the transaction is complete."}},"components/schemas/ssa_account":{"id":"components/schemas/ssa_account","kind":"json-schema","title":"ssa_account","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSA account name and address of the sender in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"minLength":1,"maxLength":128}},"components/schemas/ssa_transfer_state":{"id":"components/schemas/ssa_transfer_state","kind":"json-schema","title":"ssa_transfer_state","data":{"type":"string","description":"The state of the SSA transfer.","minLength":1,"maxLength":128}},"components/schemas/ssa_transfer_currency":{"id":"components/schemas/ssa_transfer_currency","kind":"json-schema","title":"ssa_transfer_currency","data":{"type":"string","description":"The three-letter code of the currency associated with this SSA transfer.","minLength":1,"maxLength":128}},"components/schemas/withdrawal_result_details_transaction_id":{"id":"components/schemas/withdrawal_result_details_transaction_id","kind":"json-schema","title":"withdrawal_result_details_transaction_id","data":{"type":"string","minLength":1,"maxLength":128,"description":"XRP transaction hash if there is on-ledger movement.","example":"5b0a25b79595123d80dd27c0808fb554"}},"components/schemas/destination_result_id":{"id":"components/schemas/destination_result_id","kind":"json-schema","title":"destination_result_id","data":{"type":"string","minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the destination trade at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination_exchange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2c3367d2-ab12-3456-78c9-d9edbf6bcbc5"}},"components/schemas/PaymentOpsReportTransactionBase":{"id":"components/schemas/PaymentOpsReportTransactionBase","kind":"json-schema","title":"Payment operations base","data":{"title":"Payment operations base","x-implements":["ReportTransaction"],"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are the data fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_OPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report you download from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. Use this report for high-level payment investigation and reporting."},"children":[]}]}]}],"properties":{"end_to_end_id":{"$ref":"#/components/schemas/end_to_end_id"},"ripplenet_payment_id":{"$ref":"#/components/schemas/ripplenet_payment_id"},"quote_ts":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp of the quote."},"children":[]}]}]}],"format":"date-time"},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp when the transaction was created."},"children":[]}]}]}],"format":"date-time","example":"2022-10-02T20:57:13.606Z"},"executed_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp when the payment was settled."},"children":[]}]}]}],"format":"date-time","example":"2022-10-02T20:57:20.62Z"},"sender_address":{"$ref":"#/components/schemas/sender_address"},"sender_customer":{"$ref":"#/components/schemas/sender_customer"},"sent_amount":{"$ref":"#/components/schemas/sent_amount"},"sent_currency":{"$ref":"#/components/schemas/sent_currency"},"receiver_address":{"$ref":"#/components/schemas/receiver_address"},"receiver_customer":{"$ref":"#/components/schemas/receiver_customer"},"received_amount":{"$ref":"#/components/schemas/received_amount"},"received_currency":{"$ref":"#/components/schemas/received_currency"},"payment_method":{"$ref":"#/components/schemas/payment_method"},"payment_state":{"$ref":"#/components/schemas/payment_state"},"remitter_name":{"$ref":"#/components/schemas/remitter_name"},"remitter_account":{"$ref":"#/components/schemas/remitter_account"},"beneficiary_name":{"$ref":"#/components/schemas/beneficiary_name"},"beneficiary_account":{"$ref":"#/components/schemas/beneficiary_account"},"payment_batch_id":{"$ref":"#/components/schemas/payment_batch_id"}}}},"components/schemas/PaymentOpsReportTransaction":{"id":"components/schemas/PaymentOpsReportTransaction","kind":"json-schema","title":"Payment operations","data":{"title":"Payment operations","type":"object","additionalProperties":false,"x-parent":"PaymentOpsReportTransactionBase","properties":{"end_to_end_id":{"$ref":"#/components/schemas/end_to_end_id"},"ripplenet_payment_id":{"$ref":"#/components/schemas/ripplenet_payment_id"},"quote_ts":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp of the quote."},"children":[]}]}]}],"format":"date-time"},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp when the transaction was created."},"children":[]}]}]}],"format":"date-time","example":"2022-10-02T20:57:13.606Z"},"executed_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp when the payment was settled."},"children":[]}]}]}],"format":"date-time","example":"2022-10-02T20:57:20.62Z"},"sender_address":{"$ref":"#/components/schemas/sender_address"},"sender_customer":{"$ref":"#/components/schemas/sender_customer"},"sent_amount":{"$ref":"#/components/schemas/sent_amount"},"sent_currency":{"$ref":"#/components/schemas/sent_currency"},"withdrawal_result_amount":{"$ref":"#/components/schemas/withdrawal_result_amount"},"receiver_address":{"$ref":"#/components/schemas/receiver_address"},"receiver_customer":{"$ref":"#/components/schemas/receiver_customer"},"received_amount":{"$ref":"#/components/schemas/received_amount"},"received_currency":{"$ref":"#/components/schemas/received_currency"},"fx_spot_rate":{"$ref":"#/components/schemas/fx_spot_rate"},"source_exchange":{"$ref":"#/components/schemas/source_exchange"},"destination_exchange":{"$ref":"#/components/schemas/destination_exchange"},"payment_method":{"$ref":"#/components/schemas/payment_method"},"payment_state":{"$ref":"#/components/schemas/payment_state"},"remitter_name":{"$ref":"#/components/schemas/remitter_name"},"remitter_account":{"$ref":"#/components/schemas/remitter_account"},"beneficiary_name":{"$ref":"#/components/schemas/beneficiary_name"},"beneficiary_account":{"$ref":"#/components/schemas/beneficiary_account"},"payment_batch_id":{"$ref":"#/components/schemas/payment_batch_id"}},"x-jackson-property-order":{"props":["end_to_end_id","ripplenet_payment_id","quote_ts","created_at","executed_at","sender_address","sender_customer","sent_amount","sent_currency","withdrawal_result_amount","receiver_address","receiver_customer","received_amount","received_currency","fx_spot_rate","source_exchange","destination_exchange","payment_method","payment_state","remitter_name","remitter_account","beneficiary_name","beneficiary_account","payment_batch_id"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are the data fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_OPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report you download from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. Use this report for high-level payment investigation and reporting."},"children":[]}]}]}],"x-tags":["Report data fields"]}},"components/schemas/ReconciliationReportTransaction":{"id":"components/schemas/ReconciliationReportTransaction","kind":"json-schema","title":"Reconciliation","data":{"title":"Reconciliation","x-implements":["ReportTransaction"],"type":"object","additionalProperties":false,"properties":{"end_to_end_id":{"$ref":"#/components/schemas/end_to_end_id"},"ripplenet_payment_id":{"$ref":"#/components/schemas/ripplenet_payment_id"},"payment_state":{"$ref":"#/components/schemas/payment_state"},"internal_payment_state":{"$ref":"#/components/schemas/internal_payment_state"},"quote_ts":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp of the quote."},"children":[]}]}]}],"format":"date-time","example":"2022-10-02T20:57:13.593Z"},"executed_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp when the payment was settled."},"children":[]}]}]}],"format":"date-time","example":"2022-10-02T20:57:20.62Z"},"sender_address":{"$ref":"#/components/schemas/sender_address"},"sender_customer":{"$ref":"#/components/schemas/sender_customer"},"sent_amount":{"$ref":"#/components/schemas/sent_amount"},"sent_currency":{"$ref":"#/components/schemas/sent_currency"},"receiver_address":{"$ref":"#/components/schemas/receiver_address"},"receiver_customer":{"$ref":"#/components/schemas/receiver_customer"},"received_amount":{"$ref":"#/components/schemas/received_amount"},"received_currency":{"$ref":"#/components/schemas/received_currency"},"fx_spot_rate":{"$ref":"#/components/schemas/fx_spot_rate"},"source_exchange":{"$ref":"#/components/schemas/source_exchange"},"destination_exchange":{"$ref":"#/components/schemas/destination_exchange"},"payment_method":{"$ref":"#/components/schemas/payment_method"},"transaction_id":{"$ref":"#/components/schemas/transaction_id"},"transaction_type":{"$ref":"#/components/schemas/transaction_type"},"transaction_state":{"$ref":"#/components/schemas/transaction_state"},"venue_id":{"$ref":"#/components/schemas/venue_id"},"source_result_amount":{"$ref":"#/components/schemas/source_result_amount"},"source_result_adjusted_amount":{"$ref":"#/components/schemas/source_result_adjusted_amount"},"source_result_proceeds":{"$ref":"#/components/schemas/source_result_proceeds"},"source_result_adjusted_proceeds":{"$ref":"#/components/schemas/source_result_adjusted_proceeds"},"withdrawal_result_id":{"$ref":"#/components/schemas/withdrawal_result_id"},"withdrawal_result_details_transaction_id":{"$ref":"#/components/schemas/withdrawal_result_details_transaction_id"},"withdrawal_result_amount":{"$ref":"#/components/schemas/withdrawal_result_amount"},"withdrawal_result_fee_amount":{"$ref":"#/components/schemas/withdrawal_result_fee_amount"},"withdrawal_result_incentive_value":{"$ref":"#/components/schemas/withdrawal_result_incentive_value"},"deposit_result_id":{"$ref":"#/components/schemas/deposit_result_id"},"deposit_result_amount":{"$ref":"#/components/schemas/deposit_result_amount"},"deposit_result_fee_amount":{"$ref":"#/components/schemas/deposit_result_fee_amount"},"balance_change_currency":{"$ref":"#/components/schemas/balance_change_currency"},"balance_change":{"$ref":"#/components/schemas/balance_change"},"balance_result":{"$ref":"#/components/schemas/balance_result"},"destination_result_id":{"$ref":"#/components/schemas/destination_result_id"},"destination_result_amount":{"$ref":"#/components/schemas/destination_result_amount"},"destination_result_adjusted_amount":{"$ref":"#/components/schemas/destination_result_adjusted_amount"},"destination_result_incentive_value":{"$ref":"#/components/schemas/destination_result_incentive_value"},"destination_result_proceeds":{"$ref":"#/components/schemas/destination_result_proceeds"},"destination_result_adjusted_proceeds":{"$ref":"#/components/schemas/destination_result_adjusted_proceeds"},"liquidation_status":{"$ref":"#/components/schemas/liquidation_status"},"liquidation_trade_request_status":{"$ref":"#/components/schemas/liquidation_trade_request_status"},"payment_batch_id":{"$ref":"#/components/schemas/payment_batch_id"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are the data fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report you download from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. Use this for reconciliation and detailed state-by-state investigation."},"children":[]}]}]}],"x-tags":["Report data fields"]}},"components/schemas/FailureConversionSsaTransaction":{"id":"components/schemas/FailureConversionSsaTransaction","kind":"json-schema","title":"Failure conversion & SSA","data":{"title":"Failure conversion & SSA","x-implements":["ReportTransaction"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are the data fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE_CONVERSION_SSA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report you download from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. Use this information to investigate failed payments."},"children":[]}]}]}],"additionalProperties":false,"properties":{"end_to_end_id":{"$ref":"#/components/schemas/end_to_end_id"},"ripplenet_payment_id":{"$ref":"#/components/schemas/ripplenet_payment_id"},"execution_result_type":{"$ref":"#/components/schemas/execution_result_type"},"execution_timestamp":{"type":"string","description":"The timestamp for when the failure conversion transaction happened.","format":"date-time"},"fx_rate":{"$ref":"#/components/schemas/fx_rate"},"intermediary_delta":{"$ref":"#/components/schemas/intermediary_delta"},"payment_state":{"$ref":"#/components/schemas/payment_state"},"sent_amount":{"$ref":"#/components/schemas/sent_amount"},"sent_currency":{"$ref":"#/components/schemas/sent_currency"},"received_amount":{"$ref":"#/components/schemas/received_amount"},"received_currency":{"$ref":"#/components/schemas/received_currency"},"transfer_currency":{"$ref":"#/components/schemas/transfer_currency"},"venue_id":{"$ref":"#/components/schemas/venue_id"},"ssa_account":{"$ref":"#/components/schemas/ssa_account"},"sender_customer":{"$ref":"#/components/schemas/sender_customer"},"ssa_remote_transfer_id":{"$ref":"#/components/schemas/ssa_remote_transfer_id"},"ssa_transfer_amount":{"$ref":"#/components/schemas/ssa_transfer_amount"},"ssa_balance_change":{"$ref":"#/components/schemas/ssa_balance_change"},"ssa_balance_result":{"$ref":"#/components/schemas/ssa_balance_result"},"ssa_transfer_currency":{"$ref":"#/components/schemas/ssa_transfer_currency"},"ssa_transfer_state":{"$ref":"#/components/schemas/ssa_transfer_state"}},"x-tags":["Report data fields"]}},"components/schemas/ErrorCodeEnum":{"id":"components/schemas/ErrorCodeEnum","kind":"json-schema","title":"ErrorCodeEnum","data":{"type":"string","enum":["Bad Request. The request has syntax error or is incorrectly formed","Unprocessable Request. The semantic validation of the request values failed","Resource is not found on the server","Request Authentication Failed","Forbidden Request","Generic Client Error","Generic Server Error","There are too many requests and are above the rate limits defined for the API"],"x-enum-varnames":["RPT_1","RPT_2","RPT_3","RPT_4","RPT_5","RPT_6","RPT_7","RPT_8"],"x-enumDescriptions":{"RPT_1":"Bad Request. The request has syntax error or is incorrectly formed","RPT_2":"Unprocessable Request. The semantic validation of the request values failed","RPT_3":"Resource is not found on the server","RPT_4":"Request Authentication Failed","RPT_5":"Forbidden Request","RPT_6":"Generic Client Error","RPT_7":"Generic Server Error","RPT_8":"There are too many requests and are above the rate limits defined for the API"},"example":"RPT_1"}},"components/schemas/ReportTypeEnum":{"id":"components/schemas/ReportTypeEnum","kind":"json-schema","title":"ReportTypeEnum","data":{"type":"string","description":"The report type of the downloadable report.\n","enum":["PAYMENT_OPS","RECON","FAILURE_CONVERSION_SSA"],"x-enumDescriptions":{"PAYMENT_OPS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic payment report suitable for high-level payment investigation and reporting."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment report data fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"RECON":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconciliation report suitable for reconciliation and detailed state-by-state investigation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconciliation report data fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"FAILURE_CONVERSION_SSA":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure conversion & SSA report suitable for failed payments investigation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure conversion & SSA report data fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"components/schemas/ReportFormatEnum":{"id":"components/schemas/ReportFormatEnum","kind":"json-schema","title":"ReportFormatEnum","data":{"type":"string","description":"The report format of the downloadable report.\n","enum":["CSV","JSON"],"x-enumDescriptions":{"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."}}},"components/schemas/ReportStatusEnum":{"id":"components/schemas/ReportStatusEnum","kind":"json-schema","title":"ReportStatusEnum","data":{"type":"string","description":"The status of the report.\n","enum":["PENDING","READY","FAILED","EMPTY"],"x-enumDescriptions":{"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"}},"components/schemas/ReportEndpointEnum":{"id":"components/schemas/ReportEndpointEnum","kind":"json-schema","title":"ReportEndpointEnum","data":{"type":"string","enum":["EXTERNAL","INTERNAL"],"x-enumDescriptions":{"EXTERNAL":"External endpoint","INTERNAL":"Internal endpoint"},"example":"INTERNAL"}},"components/schemas/CreatedByEnum":{"id":"components/schemas/CreatedByEnum","kind":"json-schema","title":"CreatedByEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query for report types based on the entity that initiated report creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get automated system-generated reports."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customized reports generated by users through the UI."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customized reports generated using the API."},"children":[]}]}]}]}]}]}],"enum":["USER","SCHEDULER","API"],"example":"USER"}},"components/schemas/ReportCreatedBy":{"id":"components/schemas/ReportCreatedBy","kind":"json-schema","title":"ReportCreatedBy","data":{"type":"string","minLength":1,"maxLength":128,"example":"Norma Jean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the entity that initiated the report creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated system-generated report initiated by the scheduler."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-generated report initiated through the API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[full name]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name of the user who initiated the creation of the report through the UI."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy support for older reports."},"children":[]}]}]}]}]}]}]}},"components/schemas/DeleteReportsResponse":{"id":"components/schemas/DeleteReportsResponse","kind":"json-schema","title":"DeleteReportsResponse","data":{"type":"string","minLength":1,"maxLength":128}},"components/schemas/UpdateCronJobsInfo":{"id":"components/schemas/UpdateCronJobsInfo","kind":"json-schema","title":"UpdateCronJobsInfo","data":{"required":["cronExpression","jobGroup"],"type":"object","additionalProperties":false,"properties":{"jobGroup":{"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"jobStatus":{"$ref":"#/components/schemas/JobStatus"},"cronExpression":{"type":"string","minLength":1,"maxLength":128}}}},"components/schemas/SchedulerJobInfo":{"id":"components/schemas/SchedulerJobInfo","kind":"json-schema","title":"SchedulerJobInfo","data":{"required":["cronExpression","cronJob","description","jobClassName","jobGroup","jobName","jobStatus","repeatTime","tenantId"],"type":"object","additionalProperties":false,"properties":{"jobId":{"type":"string","format":"uuid"},"jobGroup":{"type":"string","minLength":1,"maxLength":128},"jobName":{"type":"string","minLength":1,"maxLength":128},"jobStatus":{"$ref":"#/components/schemas/JobStatus"},"tenantId":{"type":"string","minLength":1,"maxLength":128},"jobClassName":{"type":"string","minLength":1,"maxLength":128},"cronExpression":{"type":"string","minLength":1,"maxLength":128},"description":{"type":"string","minLength":1,"maxLength":128},"repeatTime":{"type":"integer","format":"int64"},"cronJob":{"type":"boolean"},"priority":{"type":"integer"}}}},"components/schemas/SchedulerJobInfoList":{"id":"components/schemas/SchedulerJobInfoList","kind":"json-schema","title":"SchedulerJobInfoList","data":{"required":["jobs"],"type":"object","additionalProperties":false,"properties":{"jobs":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/SchedulerJobInfo"}}}}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"string","minLength":1,"maxLength":128,"enum":["PAUSED","RESUMED","SCHEDULED","SCHEDULED_STARTED","EDITED_SCHEDULED"]}},"schema_0":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CreatedByEnum"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report data fields vary depending on the selected report."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data fields"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_OPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment report data fields"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECON"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconciliation report data fields"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE_CONVERSION_SSA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure conversion & SSA report data fields"},"children":[]}]}]}]}]}]}]}],"oneOf":[{"$ref":"#/components/schemas/PaymentOpsReportTransaction"},{"$ref":"#/components/schemas/ReconciliationReportTransaction"},{"$ref":"#/components/schemas/FailureConversionSsaTransaction"}]},"id":"schema_3"}},"exampleStore":{"components/examples/PaymentOpsReportResponse":{"id":"components/examples/PaymentOpsReportResponse","value":{"end_to_end_id":"string","ripplenet_payment_id":"70eccd4f-abcd-1234-a655-3aeddff19e4a","quote_ts":"2019-08-24T14:15:22Z","created_at":"2022-10-02T20:57:13.606Z","executed_at":"2022-10-02T20:57:20.62Z","sender_address":"new_york@rn.us.ny.new_york","sender_customer":"examplecorp_sf","sent_amount":40,"sent_currency":"USD","withdrawal_result_amount":39.846668,"receiver_address":"new_york@rn.us.ny.new_york","receiver_customer":"sf","received_amount":39.45,"received_currency":"PHP","fx_spot_rate":58.70956379,"source_exchange":"bitstamp","destination_exchange":"independentreserve","payment_method":"CSM_TH_THB","payment_state":"COMPLETED","remitter_name":"string","remitter_account":"string","beneficiary_name":"string","beneficiary_account":"string","payment_batch_id":"497f6eca-1234-5678-bfeb-53cbbbba6f08"}},"components/examples/ReconReportResponse":{"id":"components/examples/ReconReportResponse","value":{"end_to_end_id":"string","ripplenet_payment_id":"70eccd4f-abcd-1234-a655-3aeddff19e4a","payment_state":"COMPLETED","internal_payment_state":"DONE","quote_ts":"2022-10-02T20:57:13.593Z","executed_at":"2022-10-02T20:57:20.62Z","sender_address":"new_york@rn.us.ny.new_york","sender_customer":"examplecorp_sf","sent_amount":40,"sent_currency":"USD","receiver_address":"new_york@rn.us.ny.new_york","receiver_customer":"sf","received_amount":39.45,"received_currency":"PHP","fx_spot_rate":58.70956379,"source_exchange":"bitstamp","destination_exchange":"independentreserve","payment_method":"CSM_TH_THB","transaction_id":"a557eb2d-abcd-1234-a9a0-fdb5b52aaa02","transaction_type":"TRADE","transaction_state":"COMPLETE","venue_id":"8eef087a-abcd-1234-922d-e802b1126ea0","source_result_amount":0,"source_result_adjusted_amount":0,"source_result_proceeds":0,"source_result_adjusted_proceeds":0,"withdrawal_result_id":"2b325317-abcd-1234-9aa2-0d5eb2c3c0e1","withdrawal_result_details_transaction_id":"5b0a25b79595123d80dd27c0808fb554","withdrawal_result_amount":39.846668,"withdrawal_result_fee_amount":0,"withdrawal_result_incentive_value":0,"deposit_result_id":"18700e69-1234-abcd-5678-cb17d5ccdbca","deposit_result_amount":0,"deposit_result_fee_amount":0,"balance_change_currency":"usd","balance_change":0,"balance_result":0,"destination_result_id":"2c3367d2-ab12-3456-78c9-d9edbf6bcbc5","destination_result_amount":0,"destination_result_adjusted_amount":0,"destination_result_incentive_value":0,"destination_result_proceeds":0,"destination_result_adjusted_proceeds":0,"liquidation_status":"string","payment_batch_id":"497f6eca-1234-5678-bfeb-53cbbbba6f08"}},"components/examples/FailureConversionSsaReportResponse":{"id":"components/examples/FailureConversionSsaReportResponse","value":{"end_to_end_id":"0f1cf226-7586-4324-b4c0-520e602e6acd","ripplenet_payment_id":"70eccd4f-abcd-1234-a655-3aeddff19e4a","execution_result_type":"CRYPTO_TRANSFER","execution_timestamp":"2019-08-24T14:15:22Z","fiat_adjusted_value":0,"fx_rate":0,"intermediary_delta":-1.205453,"payment_state":"COMPLETED","sent_amount":40,"sent_currency":"USD","received_amount":39.45,"received_currency":"PHP","transfer_currency":"XRP","venue_id":"8eef087a-abcd-1234-922d-e802b1126ea0","ssa_account":"customer@test.jane-doe-env","sender_customer":"examplecorp_sf","ssa_remote_transfer_id":"d9b9063a-35e1-4c7d-8a0a-f4b1d93ac03e","ssa_transfer_amount":0,"ssa_balance_change":0,"ssa_balance_result":0,"ssa_transfer_currency":"XRP","ssa_transfer_state":"PREPARED"}},"paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/PaymentOpsReportResponse":{"value":{"end_to_end_id":"string","ripplenet_payment_id":"70eccd4f-abcd-1234-a655-3aeddff19e4a","quote_ts":"2019-08-24T14:15:22Z","created_at":"2022-10-02T20:57:13.606Z","executed_at":"2022-10-02T20:57:20.62Z","sender_address":"new_york@rn.us.ny.new_york","sender_customer":"examplecorp_sf","sent_amount":40,"sent_currency":"USD","withdrawal_result_amount":39.846668,"receiver_address":"new_york@rn.us.ny.new_york","receiver_customer":"sf","received_amount":39.45,"received_currency":"PHP","fx_spot_rate":58.70956379,"source_exchange":"bitstamp","destination_exchange":"independentreserve","payment_method":"CSM_TH_THB","payment_state":"COMPLETED","remitter_name":"string","remitter_account":"string","beneficiary_name":"string","beneficiary_account":"string","payment_batch_id":"497f6eca-1234-5678-bfeb-53cbbbba6f08"},"key":"PaymentOpsReportResponse","summary":"PaymentOpsReportResponse","id":"paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/PaymentOpsReportResponse"},"paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/ReconReportResponse":{"value":{"end_to_end_id":"string","ripplenet_payment_id":"70eccd4f-abcd-1234-a655-3aeddff19e4a","payment_state":"COMPLETED","internal_payment_state":"DONE","quote_ts":"2022-10-02T20:57:13.593Z","executed_at":"2022-10-02T20:57:20.62Z","sender_address":"new_york@rn.us.ny.new_york","sender_customer":"examplecorp_sf","sent_amount":40,"sent_currency":"USD","receiver_address":"new_york@rn.us.ny.new_york","receiver_customer":"sf","received_amount":39.45,"received_currency":"PHP","fx_spot_rate":58.70956379,"source_exchange":"bitstamp","destination_exchange":"independentreserve","payment_method":"CSM_TH_THB","transaction_id":"a557eb2d-abcd-1234-a9a0-fdb5b52aaa02","transaction_type":"TRADE","transaction_state":"COMPLETE","venue_id":"8eef087a-abcd-1234-922d-e802b1126ea0","source_result_amount":0,"source_result_adjusted_amount":0,"source_result_proceeds":0,"source_result_adjusted_proceeds":0,"withdrawal_result_id":"2b325317-abcd-1234-9aa2-0d5eb2c3c0e1","withdrawal_result_details_transaction_id":"5b0a25b79595123d80dd27c0808fb554","withdrawal_result_amount":39.846668,"withdrawal_result_fee_amount":0,"withdrawal_result_incentive_value":0,"deposit_result_id":"18700e69-1234-abcd-5678-cb17d5ccdbca","deposit_result_amount":0,"deposit_result_fee_amount":0,"balance_change_currency":"usd","balance_change":0,"balance_result":0,"destination_result_id":"2c3367d2-ab12-3456-78c9-d9edbf6bcbc5","destination_result_amount":0,"destination_result_adjusted_amount":0,"destination_result_incentive_value":0,"destination_result_proceeds":0,"destination_result_adjusted_proceeds":0,"liquidation_status":"string","payment_batch_id":"497f6eca-1234-5678-bfeb-53cbbbba6f08"},"key":"ReconReportResponse","summary":"ReconReportResponse","id":"paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/ReconReportResponse"},"paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/FailureConversionSsaReportResponse":{"value":{"end_to_end_id":"0f1cf226-7586-4324-b4c0-520e602e6acd","ripplenet_payment_id":"70eccd4f-abcd-1234-a655-3aeddff19e4a","execution_result_type":"CRYPTO_TRANSFER","execution_timestamp":"2019-08-24T14:15:22Z","fiat_adjusted_value":0,"fx_rate":0,"intermediary_delta":-1.205453,"payment_state":"COMPLETED","sent_amount":40,"sent_currency":"USD","received_amount":39.45,"received_currency":"PHP","transfer_currency":"XRP","venue_id":"8eef087a-abcd-1234-922d-e802b1126ea0","ssa_account":"customer@test.jane-doe-env","sender_customer":"examplecorp_sf","ssa_remote_transfer_id":"d9b9063a-35e1-4c7d-8a0a-f4b1d93ac03e","ssa_transfer_amount":0,"ssa_balance_change":0,"ssa_balance_result":0,"ssa_transfer_currency":"XRP","ssa_transfer_state":"PREPARED"},"key":"FailureConversionSsaReportResponse","summary":"FailureConversionSsaReportResponse","id":"paths/~1v1~1reports~1download~1{report-id}/get/responses/200/content/application~1json/examples/FailureConversionSsaReportResponse"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"specVersion":"3.0.3","servers":[{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://reporting-test.rnc.ripplenet.com"},{"url":"https://reporting.rnc.ripplenet.com","description":"Production environment"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"}]},"schemasExpansionLevel":3,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideDownloadButtons":true,"mockServer":{"url":"/_mock/products/payments-odl/api-docs/report_service/reference/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/payments-odl/api-docs/report_service/reference/openapi.json?download"},{"url":"/_bundle/products/payments-odl/api-docs/report_service/reference/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"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<br/>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<br/>(If the current month is October) | Includes all ODL payment data for the month preceding the current month. |\n| Month Before Last| August<br/>(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<table style=\"table;table-layout: fixed; width: 100%\">\n<colgroup><col style=\"width: 15%\"><col style=\"width: 45%\"><col style=\"width: 45%\"></colgroup>\n<thead>\n  <tr>\n    <th>Environment</th>\n    <th>Base URL</th>\n    <th>Description</th>\n  </tr>\n</thead>\n<tbody>\n  <tr>\n    <td>Test</td>\n    <td><code>reporting-test.rnc.ripplenet.com</code></td>\n    <td>Test environment with simulated partners and simulated currency.</td>\n  </tr>\n  <tr>\n    <td>Production</td>\n    <td><code>reporting.rnc.ripplenet.com</code></td>\n    <td>Production environment with actual partners and actual currency.</td>\n  </tr>\n</tbody>\n</table>\n"}},"baseSlug":"/products/payments-odl/api-docs/report_service/reference/openapi","routesMapping":{}}