Ripple Labs Reports API
The Report Service API provides `PAYMENT_OPS`, `RECON`, and `FAILURE_CONVERSION_SSA` reports in either CSV or JSON format.
OpenAPI Specification
openapi: 3.0.0
info:
title: Palisade Addresses Reports API
description: The Palisade API enables programmatic interaction with the various features of the Palisade platform
version: '2.0'
servers:
- url: https://api.sandbox.palisade.co
description: Sandbox server (uses TESTNET data, private keys and accounts)
- url: https://api.palisade.co
description: Palisade server (uses MAINNET data, private keys and accounts)
security:
- TokenAuth: []
tags:
- name: Reports
description: The Report Service API provides `PAYMENT_OPS`, `RECON`, and `FAILURE_CONVERSION_SSA` reports in either CSV or JSON format.
paths:
/v1/reports:
get:
tags:
- Reports
summary: 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.
To get the download link for a specific report, store the `reportId` for the report you want, and use it with the [Get a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport) operation.
'
operationId: getReports
parameters:
- name: created-by
in: query
required: false
schema:
$ref: '#/components/schemas/CreatedByEnum'
responses:
'200':
description: Returns an array of report metadata for the calling tenant
content:
application/json:
schema:
$ref: '#/components/schemas/ReportsMetadataResponse'
'400':
description: Bad Report Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- Reports
summary: Create report
description: 'Request the generation of a custom report based on the specified parameters.
**Report duration**
Reports can contain up to 90 days of transactions from the previous 9 months.
* Minimum report duration is 1 day.
* Maximum report duration is 90 days.
#### Report retention
Reports are retained for 6 months after the `endDate` specified in your request. After this period, the report is purged and will no longer be accessible.
'
operationId: postReport
requestBody:
description: Parameters defining the requested report
content:
application/json:
schema:
$ref: '#/components/schemas/ReportRequest'
required: false
responses:
'200':
description: Returns the JSON record for the posted report
content:
application/json:
schema:
$ref: '#/components/schemas/ReportRecord'
'400':
description: Bad Report Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: body
/v1/reports/{report-id}:
get:
tags:
- Reports
summary: Get a report
description: 'Here, you apply the `report-id` from the [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) operation as the path parameter to get a `downloadlink` containing the report.
Download the report at the link in the `downloadLink` field in the response.
'
operationId: getReport
parameters:
- name: report-id
in: path
description: Unique identifier for a report.
required: true
schema:
type: string
format: uuid
example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
responses:
'200':
description: Returns the JSON record of the report specified in the path parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDownloadRecordLink'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- Reports
summary: Delete reports
description: Delete a specific report with the `report-id` path parameter.
operationId: deleteReport
parameters:
- name: report-id
in: path
description: Unique ID for a report
required: true
schema:
type: string
format: uuid
responses:
'204':
description: The resource was successfully deleted.
'404':
description: Reports not found
content: {}
'500':
description: Error while attempting to delete resource
content: {}
/v1/reports/download/{report-id}:
get:
tags:
- Reports
summary: Download a report
description: 'Download a transaction report. Download the report by applying the `report-id` from the [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) operation as a path parameter.
**Note**: Depending on the `reportId` you specified, the returned report is either a Payment operations report or a Reconciliation report.
'
operationId: getReportDownload
parameters:
- name: report-id
in: path
description: Unique identifier for a report. Get this `report-id` from the [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) operation.
required: true
schema:
type: string
format: uuid
example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
responses:
'200':
description: Returns the JSON record of the report specified in the path parameter
content:
application/json:
schema:
description: 'Report data fields vary depending on the selected report.
| Report type | Data fields |
| --- | --- |
| `PAYMENT_OPS` | [Payment report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction) |
| `RECON` | [Reconciliation report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction) |
| `FAILURE_CONVERSION_SSA` | [Failure conversion & SSA report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction) |
'
oneOf:
- $ref: '#/components/schemas/PaymentOpsReportTransaction'
- $ref: '#/components/schemas/ReconciliationReportTransaction'
- $ref: '#/components/schemas/FailureConversionSsaTransaction'
examples:
PaymentOpsReportResponse:
$ref: '#/components/examples/PaymentOpsReportResponse'
ReconReportResponse:
$ref: '#/components/examples/ReconReportResponse'
FailureConversionSsaReportResponse:
$ref: '#/components/examples/FailureConversionSsaReportResponse'
'204':
description: The contents of the report are empty
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
withdrawal_result_amount:
type: number
description: '**[Sender only]**
Final amount of XRP at `source_exchange` wallet to be withdrawn after `withdrawal_result_fee_amount` fees and `withdrawal_result_incentive_value` incentives have been applied.
**Note**: This value can be higher or lower than `source_result_proceeds` depending on whether the incentives were positive or negative.
'
example: 39.846668
ReportDownloadRecordLink:
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: The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) for a requested report.
format: date-time
example: '2018-04-06T19:33:35Z'
endDate:
type: string
description: 'The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) for a requested report.
**Note**: Must be after `startDate`, but no more than 90 days after.
'
format: date-time
example: '2018-04-06T20:33:35Z'
createdOn:
$ref: '#/components/schemas/report_created_on'
downloadLink:
type: string
minLength: 1
maxLength: 2048
description: 'Link where you can download the report in the available format. This field is available when the report `status` is `READY`.
'
format: uri
example: https://reporting-test.rnc.ripplenet.com/v1/reports/download/497f6eca-6276-4993-bfeb-53cbbbba6f08
reportCreatedBy:
$ref: '#/components/schemas/ReportCreatedBy'
source_result_adjusted_proceeds:
type: number
description: XRP amount after deduction of the conversion fees from `source_result_proceeds`.
withdrawal_result_incentive_value:
type: number
description: '**[Sender only]**
The incentive value in XRP applied to `source_result_proceeds` to arrive at the `withdrawal_result_amount` value.
'
destination_result_amount:
type: number
description: '**[Receiver only]**
The final XRP amount at destination wallet to be liquidated into received fiat currency.
'
report_name:
type: string
minLength: 1
maxLength: 256
description: User defined name of the report.
example: My custom report
receiver_address:
type: string
minLength: 1
maxLength: 128
description: RippleNet account name and address of the receiver, in the format `accountname@ripplenetaddress`.
example: new_york@rn.us.ny.new_york
liquidation_status:
type: string
minLength: 1
maxLength: 128
description: Reserved for future use.
ReportRequest:
required:
- reportName
- reportType
- reportFormat
- startDate
- endDate
type: object
additionalProperties: false
properties:
reportName:
$ref: '#/components/schemas/report_name'
startDate:
type: string
description: The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) for requested report.
format: date-time
example: '2018-04-06T19:33:35Z'
endDate:
type: string
description: 'The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) for a requested report.
**Note**: Must be after `startDate`, but no more than 90 days after.
'
format: date-time
example: '2018-04-06T20:33:35Z'
reportType:
$ref: '#/components/schemas/ReportTypeEnum'
reportFormat:
$ref: '#/components/schemas/ReportFormatEnum'
remitter_name:
type: string
minLength: 1
maxLength: 128
description: 'Complete name of the person originating the payment.
**Note**: Values are only viewable by the customer requesting the report.
'
ssa_transfer_state:
type: string
description: The state of the SSA transfer.
minLength: 1
maxLength: 128
intermediary_delta:
type: number
destination_exchange:
type: string
minLength: 1
maxLength: 128
description: '**[Receiver only]**
The destination exchange for the payment.
'
example: independentreserve
ssa_account:
type: string
description: The SSA account name and address of the sender in `accountname@ripplenetaddress` format.
minLength: 1
maxLength: 128
sender_customer:
type: string
minLength: 1
maxLength: 128
description: The name of the sending institution.
example: examplecorp_sf
internal_payment_state:
type: string
minLength: 1
maxLength: 128
description: '**[Ripple internal]**
Ripple uses this information for troubleshooting purposes.
'
example: DONE
transaction_state:
type: string
minLength: 1
maxLength: 128
description: 'The transaction state of the overall payment when it''s queried.
'
x-enumDescriptions:
COMPLETED: Transaction is complete.
EXECUTED: Transaction has executed.
FAILED: Transaction has failed.
example: COMPLETE
ssa_remote_transfer_id:
type: string
description: The unique identifier of the SSA transfer from the SSA funding account to the SSA account.
minLength: 1
maxLength: 128
received_amount:
type: number
description: The payment amount received by the beneficiary.
example: 39.45
ssa_transfer_currency:
type: string
description: The three-letter code of the currency associated with this SSA transfer.
minLength: 1
maxLength: 128
destination_result_adjusted_proceeds:
type: number
description: Amount of fiat currency received for payout including fees.
withdrawal_result_details_transaction_id:
type: string
minLength: 1
maxLength: 128
description: XRP transaction hash if there is on-ledger movement.
example: 5b0a25b79595123d80dd27c0808fb554
CreatedByEnum:
type: string
description: 'Query for report types based on the entity that initiated report creation.
| Value | Description |
|------------|----------------------------------------------------|
| SCHEDULER | Get automated system-generated reports. |
| USER | Customized reports generated by users through the UI. |
| API | Customized reports generated using the API. |
'
enum:
- USER
- SCHEDULER
- API
example: USER
balance_result:
type: number
description: Account balance after the transaction.
sender_address:
type: string
minLength: 1
maxLength: 128
description: RippleNet account name and address of the sender, in the format `accountname@ripplenetaddress`.
example: new_york@rn.us.ny.new_york
ErrorResponse:
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: The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) error timestamp.
format: date-time
example: '2018-04-06T20:33:35Z'
ripplenet_payment_id:
type: string
minLength: 1
maxLength: 128
description: The unique payment identifier.
example: 70eccd4f-abcd-1234-a655-3aeddff19e4a
transfer_currency:
type: string
description: The three-letter code of the currency associated with this transfer.
minLength: 1
maxLength: 128
payment_state:
type: string
minLength: 1
maxLength: 128
description: The state of a payment at the moment it is queried.
example: COMPLETED
destination_result_proceeds:
type: number
description: '**[Receiver only]**
Amount of fiat currency received for payout without fee.
'
received_currency:
type: string
minLength: 1
maxLength: 128
description: The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the `received_amount`.
example: PHP
FailureConversionSsaTransaction:
title: Failure conversion & SSA
x-implements:
- ReportTransaction
type: object
description: These are the data fields for the `FAILURE_CONVERSION_SSA` report you download from the [Get a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport) operation. Use this information to investigate failed payments.
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
withdrawal_result_fee_amount:
type: number
description: '**[Sender only]**
Withdrawal fee charged by the `source_exchange`. This is substracted from the total `withdrawal_result_amount`.
'
ReportRecord:
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: The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) of the report.
format: date-time
example: '2018-04-06T19:33:35Z'
endDate:
type: string
description: 'The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) of the report.
**Note**: Must be after `startDate`, but no more than 90 days after.
'
format: date-time
example: '2018-04-06T20:33:35Z'
createdOn:
$ref: '#/components/schemas/report_created_on'
transaction_type:
type: string
minLength: 1
maxLength: 128
description: 'The type of transaction.
'
x-enumDescriptions:
CRYPTO_TRANSFER: Transfer of digital assets.
FIAT_TRANSFER: Transfers of fiat.
TRADE: Trade transfers.
example: TRADE
destination_result_adjusted_amount:
type: number
description: '**[Receiver only]**
The final XRP amount at destination wallet to be liquidated including fees.
'
ReportStatusEnum:
type: string
description: 'The status of the report.
'
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
ReportTypeEnum:
type: string
description: 'The report type of the downloadable report.
'
enum:
- PAYMENT_OPS
- RECON
- FAILURE_CONVERSION_SSA
x-enumDescriptions:
PAYMENT_OPS: Basic payment report suitable for high-level payment investigation and reporting.</br>View [Payment report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction).
RECON: Reconciliation report suitable for reconciliation and detailed state-by-state investigation.</br>View [Reconciliation report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction).
FAILURE_CONVERSION_SSA: Failure conversion & SSA report suitable for failed payments investigation.</br>View [Failure conversion & SSA report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction).
fx_rate:
type: number
description: The foreign exchange rate associated with the failure conversion transaction.
withdrawal_result_id:
type: string
minLength: 1
maxLength: 128
description: '**[Sender only]**
Unique identifier for the withdrawal transaction at the `source_exchange`.
'
example: 2b325317-abcd-1234-9aa2-0d5eb2c3c0e1
ReportFormatEnum:
type: string
description: 'The report format of the downloadable report.
'
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.
payment_batch_id:
type: string
minLength: 1
maxLength: 36
description: 'Unique identifier for a batch of payments.
**Note**: This field is only populated for payments that are part of a batch.
'
payment_method:
type: string
minLength: 1
maxLength: 128
description: "**[Sender only]**\n\nMethod for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example:\n\n - CSM_ID_IDR\n - MSISDN_ID_IDR\n - CASHPICKUP_ID_IDR\n - CARD_CN_CNY\n\n Or you can use RippleNet payment method values:\n\n - REAL_TIME_GROSS_SETTLEMENT_SYSTEM\n - REAL_TIME_NET_SETTLEMENT_SYSTEM\n - MASS_NET_PAYMENT_SYSTEM\n - BOOK_TRANSFER\n - CASH_PAYOUT\n - WALLET_PAYMENT\n - OTHER\n"
example: CSM_TH_THB
beneficiary_name:
type: string
minLength: 1
maxLength: 128
description: 'Complete name of the person receiving the payment.
**Note**: Values are only viewable by the customer requesting the report.
'
beneficiary_account:
type: string
minLength: 1
maxLength: 128
description: 'Account number at the receiving institution for the payment beneficiary.
**Note**: Values are only viewable by the customer requesting the report.
'
fx_spot_rate:
type: number
description: '**[Sender only]**
The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source.
'
example: 58.70956379
venue_id:
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
execution_result_type:
type: string
description: The type of failure conversion transaction.
minLength: 1
maxLength: 128
ReconciliationReportTransaction:
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: The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp of the quote.
format: date-time
example: '2022-10-02T20:57:13.593Z'
executed_at:
type: string
description: The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the payment was settled.
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: These are the data fields for the `RECON` report you download from the [Get a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport) operation. Use this for reconciliation and detailed state-by-state investigation.
x-tags:
- Report data fields
deposit_result_id:
type: string
minLength: 1
maxLength: 128
description: '**[Receiver only]**
Unique identifier for the deposit at the `destination_exchange`.
'
example: 18700e69-1234-abcd-5678-cb17d5ccdbca
ssa_transfer_amount:
type: number
description: The SSA transfer amount.
source_exchange:
type: string
minLength: 1
maxLength: 128
description: '**[Sender only]**
The source exchange where the sender originates the payment.
'
example: bitstamp
report_created_on:
type: string
description: Report creation time
format: date-time
exampl
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ripple-labs/refs/heads/main/openapi/ripple-labs-reports-api-openapi.yml