ODL statements in Ripple Payments UI
The On-Demand Liquidity (ODL) Statement feature in Ripple Payments UI provides pre-generated reports for RippleNet payments that utilize On-Demand Liquidity
Report types
There are two ODL report types:
- Basic payment report (also known as the Payment operations report)
- Reconciliation report
ODL Statement reports do not include data on fiat payments
Fiat payments aren't included in ODL statement reports.
You can save the Fiat payments displayed in the Payments list by using the Download button
.Basic payment report
The Basic payment report, also known as the Payment operations report, provides basic payment data, including but not limited to:
- Payment ID
- Amount
- Currency
- Account info
- Payment state
- Timestamp
The Basic payment 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 for the Basic payment report, see the Payment operations report data fields.
Reconciliation report
The Reconciliation report provides all basic payment data, and it also includes 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.
ODL Statement form
To view the ODL Statement request form, go to the Payments screen and click ODL Statement.
The ODL Statement dialog displays form elements for the two reports.
Date range (UTC)
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 |
|---|---|---|
| Current month | Retrieves ODL payment data from the first day of the current month up to 1:00AM of the current day. | Assuming that October is the current month, this date range contains ODL payment data from October 1, 2022 to 1:00AM on October 10, 2022 |
| Last month | Retrieves all ODL payment data from the month preceding the current month. | September 2022 (If the current month is October 2022) |
| Month before last | Retrieves all ODL payment data from the month preceding the last month. | August 2022 (If the last month is September 2022) |
Format
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.
Type
View descriptions for the two Report types.
- Basic payment report (also known as the Payment operations report)
- Reconciliation report
Report data fields
These data fields describe the CSV and JSON content when downloaded from the ODL Statement form.
Payment operations report data fields
These are the data fields for the Payment operations report. Use this report for high-level payment investigation and reporting.
| end_to_end_id | string (end_to_end_id) [ 1 .. 128 ] characters The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment. |
| ripplenet_payment_id | string (ripplenet_payment_id) [ 1 .. 128 ] characters The unique payment identifier. |
| quote_ts | string <date-time> The ISO-8601 timestamp of the quote. |
| created_at | string <date-time> The ISO-8601 timestamp when the transaction was created. |
| executed_at | string <date-time> The ISO-8601 timestamp when the payment was settled. |
| sender_address | string (sender_address) [ 1 .. 128 ] characters RippleNet account name and address of the sender, in the format |
| sender_customer | string (sender_customer) [ 1 .. 128 ] characters The name of the sending institution. |
| sent_amount | number (sent_amount) The payment amount sent. |
| sent_currency | string (sent_currency) [ 1 .. 128 ] characters The ISO 4217 currency code of the of |
| withdrawal_result_amount | number (withdrawal_result_amount) [Sender only] Final amount of XRP at Note: This value can be higher or lower than |
| receiver_address | string (receiver_address) [ 1 .. 128 ] characters RippleNet account name and address of the receiver, in the format |
| receiver_customer | string (receiver_customer) [ 1 .. 128 ] characters Name of the receiving institution. |
| received_amount | number (received_amount) The payment amount received by the beneficiary. |
| received_currency | string (received_currency) [ 1 .. 128 ] characters The ISO 4217 currency code of the |
| fx_spot_rate | number (fx_spot_rate) [Sender only] The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source. |
| source_exchange | string (source_exchange) [ 1 .. 128 ] characters [Sender only] The source exchange where the sender originates the payment. |
| destination_exchange | string (destination_exchange) [ 1 .. 128 ] characters [Receiver only] The destination exchange for the payment. |
| payment_method | string (payment_method) [ 1 .. 128 ] characters [Sender only] Method for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example:
Or you can use RippleNet payment method values:
|
| payment_state | string (payment_state) [ 1 .. 128 ] characters The state of a payment at the moment it is queried. |
| remitter_name | string (remitter_name) [ 1 .. 128 ] characters Complete name of the person originating the payment. Note: Values are only viewable by the customer requesting the report. |
| remitter_account | string (remitter_account) [ 1 .. 128 ] characters Account number at the sending institution for the payment remitter. Note: Values are only viewable by the customer requesting the report. |
| beneficiary_name | string (beneficiary_name) [ 1 .. 128 ] characters Complete name of the person receiving the payment. Note: Values are only viewable by the customer requesting the report. |
| beneficiary_account | string (beneficiary_account) [ 1 .. 128 ] characters Account number at the receiving institution for the payment beneficiary. Note: Values are only viewable by the customer requesting the report. |
| payment_batch_id | string (payment_batch_id) [ 1 .. 36 ] characters Unique identifier for a batch of payments. Note: This field is only populated for payments that are part of a batch. |
Reconciliation report data fields
These are the data fields for the Reconciliation report. Use this for reconciliation and detailed state-by-state investigation.
| end_to_end_id | string (end_to_end_id) [ 1 .. 128 ] characters The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment. | ||||||||
| ripplenet_payment_id | string (ripplenet_payment_id) [ 1 .. 128 ] characters The unique payment identifier. | ||||||||
| payment_state | string (payment_state) [ 1 .. 128 ] characters The state of a payment at the moment it is queried. | ||||||||
| internal_payment_state | string (internal_payment_state) [ 1 .. 128 ] characters [Ripple internal] Ripple uses this information for troubleshooting purposes. | ||||||||
| quote_ts | string <date-time> The ISO-8601 timestamp of the quote. | ||||||||
| executed_at | string <date-time> The ISO-8601 timestamp when the payment was settled. | ||||||||
| sender_address | string (sender_address) [ 1 .. 128 ] characters RippleNet account name and address of the sender, in the format | ||||||||
| sender_customer | string (sender_customer) [ 1 .. 128 ] characters The name of the sending institution. | ||||||||
| sent_amount | number (sent_amount) The payment amount sent. | ||||||||
| sent_currency | string (sent_currency) [ 1 .. 128 ] characters The ISO 4217 currency code of the of | ||||||||
| receiver_address | string (receiver_address) [ 1 .. 128 ] characters RippleNet account name and address of the receiver, in the format | ||||||||
| receiver_customer | string (receiver_customer) [ 1 .. 128 ] characters Name of the receiving institution. | ||||||||
| received_amount | number (received_amount) The payment amount received by the beneficiary. | ||||||||
| received_currency | string (received_currency) [ 1 .. 128 ] characters The ISO 4217 currency code of the | ||||||||
| fx_spot_rate | number (fx_spot_rate) [Sender only] The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source. | ||||||||
| source_exchange | string (source_exchange) [ 1 .. 128 ] characters [Sender only] The source exchange where the sender originates the payment. | ||||||||
| destination_exchange | string (destination_exchange) [ 1 .. 128 ] characters [Receiver only] The destination exchange for the payment. | ||||||||
| payment_method | string (payment_method) [ 1 .. 128 ] characters [Sender only] Method for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example:
Or you can use RippleNet payment method values:
| ||||||||
| transaction_id | string (transaction_id) [ 1 .. 128 ] characters Unique identifier of the balance change between two accounts. | ||||||||
| transaction_type | string (transaction_type) [ 1 .. 128 ] characters The type of transaction.
| ||||||||
| transaction_state | string (transaction_state) [ 1 .. 128 ] characters The transaction state of the overall payment when it's queried.
| ||||||||
| venue_id | string (venue_id) [ 1 .. 128 ] characters The unique identifier associated with a transaction involving an exchange account. Sometimes it's called "exchange id" or "order id". | ||||||||
| source_result_amount | number (source_result_amount) Fiat amount before deduction of source exchange fee. | ||||||||
| source_result_adjusted_amount | number (source_result_adjusted_amount) Fiat amount after deduction of source exchange fee. | ||||||||
| source_result_proceeds | number (source_result_proceeds) XRP amount after exchange of the | ||||||||
| source_result_adjusted_proceeds | number (source_result_adjusted_proceeds) XRP amount after deduction of the conversion fees from | ||||||||
| withdrawal_result_id | string (withdrawal_result_id) [ 1 .. 128 ] characters [Sender only] Unique identifier for the withdrawal transaction at the | ||||||||
| withdrawal_result_details_transaction_id | string (withdrawal_result_details_transaction_id) [ 1 .. 128 ] characters XRP transaction hash if there is on-ledger movement. | ||||||||
| withdrawal_result_amount | number (withdrawal_result_amount) [Sender only] Final amount of XRP at Note: This value can be higher or lower than | ||||||||
| withdrawal_result_fee_amount | number (withdrawal_result_fee_amount) [Sender only] Withdrawal fee charged by the | ||||||||
| withdrawal_result_incentive_value | number (withdrawal_result_incentive_value) [Sender only] The incentive value in XRP applied to | ||||||||
| deposit_result_id | string (deposit_result_id) [ 1 .. 128 ] characters [Receiver only] Unique identifier for the deposit at the | ||||||||
| deposit_result_amount | number (deposit_result_amount) [Receiver only] The total amount of XRP deposited into the destination wallet. Must equal | ||||||||
| deposit_result_fee_amount | number (deposit_result_fee_amount) [Receiver only] Deposit fee charged in XRP by the | ||||||||
| balance_change_currency | string (balance_change_currency) [ 1 .. 128 ] characters The ISO 4217 currency code associated with the transaction account. | ||||||||
| balance_change | number (balance_change) The change in account balance caused by the corresponding transaction. | ||||||||
| balance_result | number (balance_result) Account balance after the transaction. | ||||||||
| destination_result_id | string (destination_result_id) [ 1 .. 128 ] characters Unique identifier for the destination trade at the | ||||||||
| destination_result_amount | number (destination_result_amount) [Receiver only] The final XRP amount at destination wallet to be liquidated into received fiat currency. | ||||||||
| destination_result_adjusted_amount | number (destination_result_adjusted_amount) [Receiver only] The final XRP amount at destination wallet to be liquidated including fees. | ||||||||
| destination_result_incentive_value | number (destination_result_incentive_value) The incentive value (XRP) to be added into the total | ||||||||
| destination_result_proceeds | number (destination_result_proceeds) [Receiver only] Amount of fiat currency received for payout without fee. | ||||||||
| destination_result_adjusted_proceeds | number (destination_result_adjusted_proceeds) Amount of fiat currency received for payout including fees. | ||||||||
| liquidation_status | string (liquidation_status) [ 1 .. 128 ] characters Reserved for future use. | ||||||||
| liquidation_trade_request_status | string (liquidation_trade_request_status) [ 1 .. 128 ] characters Reserved for future use. | ||||||||
| payment_batch_id | string (payment_batch_id) [ 1 .. 36 ] characters Unique identifier for a batch of payments. Note: This field is only populated for payments that are part of a batch. |