The On-Demand Liquidity (ODL) Statement feature in the Ripple Payments UI provides pre-generated reports for RippleNet payments that utilize On-Demand Liquidity.
ODL Statement reports do not include data on fiat payments.
To retrieve data on fiat payments, apply filters to the Payments list view and click the Download button 
.
The following ODL report types are available:
The Payment operations report provides basic payment data, including but not limited to:
- Payment ID
- Amount
- Currency
- Account info
- Payment state
- Timestamp
The Payment operations report lists one payment per line, but it does not provide the transaction data within payments. To view the complete list of fields and field descriptions, see the Payment operations report data fields.
The Failure conversion & SSA report provides data for failed payments whose funds were transferred to the Sender Segregated Account (SSA). This type of report is only visible in case a failure conversion has happened.
To view the complete list of fields and field descriptions for the Failure conversion & SSA report, see the Failure conversion & SSA report data fields.
The Reconciliation report provides all basic payment data, as well as trade and liquidation data. The additional fields are useful for reconciling and thoroughly investigating payments. The Reconciliation report displays all transactions that may take place within a payment. A single payment with multiple transactions appears in multiple lines, one line per transaction. Each line includes data that has occurred during the transaction, and all subordinate transactions share the same Payment ID.
To view the complete list of fields and field descriptions for the Reconciliation report, see the Reconciliation report data fields.
To view the ODL Statement form, go to the Payments screen and click ODL Statement.
The ODL Statement form displays options for the available reports.
In the Date Range (UTC) section of the ODL Statement dialog, you have three options for defining the scope of a report:
| Date range | Description | Example |
|---|---|---|
| Month before last | Retrieves all ODL payment data from the month preceding the last month. | If the current month is October 2022, this retrieves payment data for August 2022. |
| Last month | Retrieves all ODL payment data from the month preceding the current month. | If the current month is October 2022, this retrieves payment data for September 2022. |
| Current month | Retrieves ODL payment data from the first day of the current month up to 00:00 AM of the current day. | If today's date is October 10, 2022, this retrieves ODL payment data from October 1, 2022 to 00:00 AM on October 10, 2022. |
There are two format options for ODL Statement reports:
- CSV (Comma-Separated Values): A CSV file is a text file that uses a comma to delimit values. Each line of text corresponds to a unique record.
- JSON (Javascript Object Notation): JSON is a file format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays.
View descriptions for the available Report types.
- Payment operations report
- Failure conversion & SSA report
- Reconciliation report
These data fields describe the CSV and JSON content when downloaded from the ODL Statement form.
These are the data fields for the Payment operations report. Use this report for high-level payment investigation and reporting.
The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment.
The unique payment identifier.
The ISO-8601 timestamp of the quote.
The ISO-8601 timestamp when the transaction was created.
The ISO-8601 timestamp when the payment was settled.
RippleNet account name and address of the sender, in the format accountname@ripplenetaddress.
The name of the sending institution.
The payment amount sent.
The ISO 4217 currency code of the of sent_amount.
[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.
RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress.
Name of the receiving institution.
The payment amount received by the beneficiary.
The ISO 4217 currency code of the received_amount.
[Sender only]
The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source.
[Sender only]
The source exchange where the sender originates the payment.
[Receiver only]
The destination exchange for the payment.
[Sender only]
Method for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example:
- CSM_ID_IDR
- MSISDN_ID_IDR
- CASHPICKUP_ID_IDR
- CARD_CN_CNY
Or you can use RippleNet payment method values:
- REAL_TIME_GROSS_SETTLEMENT_SYSTEM
- REAL_TIME_NET_SETTLEMENT_SYSTEM
- MASS_NET_PAYMENT_SYSTEM
- BOOK_TRANSFER
- CASH_PAYOUT
- WALLET_PAYMENT
- OTHER
The state of a payment at the moment it is queried.
Complete name of the person originating the payment.
Note: Values are only viewable by the customer requesting the report.
Account number at the sending institution for the payment remitter.
Note: Values are only viewable by the customer requesting the report.
Complete name of the person receiving the payment.
Note: Values are only viewable by the customer requesting the report.
Account number at the receiving institution for the payment beneficiary.
Note: Values are only viewable by the customer requesting the report.
Unique identifier for a batch of payments.
Note: This field is only populated for payments that are part of a batch.
These are the data fields for the Failure conversion & SSA report. Use this for detailed state-by-state investigation.
The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment.
The unique payment identifier.
The type of failure conversion transaction.
The timestamp for when the failure conversion transaction happened.
The foreign exchange rate associated with the failure conversion transaction.
The state of a payment at the moment it is queried.
The payment amount sent.
The ISO 4217 currency code of the of sent_amount.
The payment amount received by the beneficiary.
The ISO 4217 currency code of the received_amount.
The three-letter code of the currency associated with this transfer.
The unique identifier associated with a transaction involving an exchange account. Sometimes it's called "exchange id" or "order id".
The SSA account name and address of the sender in accountname@ripplenetaddress format.
The name of the sending institution.
The unique identifier of the SSA transfer from the SSA funding account to the SSA account.
The SSA transfer amount.
The change in SSA balance caused by the corresponding transaction.
The SSA account balance after the transaction is complete.
The three-letter code of the currency associated with this SSA transfer.
The state of the SSA transfer.
These are the data fields for the Reconciliation report. Use this for reconciliation and detailed state-by-state investigation.
The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment.
The unique payment identifier.
The state of a payment at the moment it is queried.
[Ripple internal]
Ripple uses this information for troubleshooting purposes.
The ISO-8601 timestamp when the payment was settled.
RippleNet account name and address of the sender, in the format accountname@ripplenetaddress.
The name of the sending institution.
The payment amount sent.
The ISO 4217 currency code of the of sent_amount.
RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress.
Name of the receiving institution.
The payment amount received by the beneficiary.
The ISO 4217 currency code of the received_amount.
[Sender only]
The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source.
[Sender only]
The source exchange where the sender originates the payment.
[Receiver only]
The destination exchange for the payment.
[Sender only]
Method for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example:
- CSM_ID_IDR
- MSISDN_ID_IDR
- CASHPICKUP_ID_IDR
- CARD_CN_CNY
Or you can use RippleNet payment method values:
- REAL_TIME_GROSS_SETTLEMENT_SYSTEM
- REAL_TIME_NET_SETTLEMENT_SYSTEM
- MASS_NET_PAYMENT_SYSTEM
- BOOK_TRANSFER
- CASH_PAYOUT
- WALLET_PAYMENT
- OTHER
Unique identifier of the balance change between two accounts.
The type of transaction.
| Enum Value | Description |
|---|---|
| CRYPTO_TRANSFER | Transfer of digital assets. |
| FIAT_TRANSFER | Transfers of fiat. |
| TRADE | Trade transfers. |
The transaction state of the overall payment when it's queried.
| Enum Value | Description |
|---|---|
| COMPLETED | Transaction is complete. |
| EXECUTED | Transaction has executed. |
| FAILED | Transaction has failed. |
The unique identifier associated with a transaction involving an exchange account. Sometimes it's called "exchange id" or "order id".
Fiat amount before deduction of source exchange fee.
Fiat amount after deduction of source exchange fee.
XRP amount after exchange of the source_result_adjusted_amount at the source_exchange.
XRP amount after deduction of the conversion fees from source_result_proceeds.
[Sender only]
Unique identifier for the withdrawal transaction at the source_exchange.
XRP transaction hash if there is on-ledger movement.
[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.
[Sender only]
Withdrawal fee charged by the source_exchange. This is substracted from the total withdrawal_result_amount.
[Sender only]
The incentive value in XRP applied to source_result_proceeds to arrive at the withdrawal_result_amount value.
[Receiver only]
Unique identifier for the deposit at the destination_exchange.
[Receiver only]
The total amount of XRP deposited into the destination wallet. Must equal withdrawal_result_amount, minus negligible ledger fees.
[Receiver only]
Deposit fee charged in XRP by the destination_exchange.
The ISO 4217 currency code associated with the transaction account.
The change in account balance caused by the corresponding transaction.
Account balance after the transaction.
Unique identifier for the destination trade at the destination_exchange.
[Receiver only]
The final XRP amount at destination wallet to be liquidated into received fiat currency.
[Receiver only]
The final XRP amount at destination wallet to be liquidated including fees.
The incentive value (XRP) to be added into the total destination_result_amount.
[Receiver only]
Amount of fiat currency received for payout without fee.
Amount of fiat currency received for payout including fees.
Reserved for future use.
Reserved for future use.
Unique identifier for a batch of payments.
Note: This field is only populated for payments that are part of a batch.