Ripple Labs Reports API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
5 operations
across 3 paths,
and defines 75 schemas.
It is described by OpenAPI 3.2.0.
Requests are made against 2 base URLs: https://reporting-test.rnc.ripplenet.com, https://reporting.rnc.ripplenet.com.
The identity and technical contract details declared by the specification.
withdrawal_result_incentive_value
number
[Sender only] The incentive value in XRP applied to sourceresultproceeds to arrive at the withdrawalresultamount value.
ssa_transfer_currency
string
The three-letter code of the currency associated with this SSA transfer.
sender_address
string
RippleNet account name and address of the sender, in the format accountname@ripplenetaddress.
CreatedByEnum
string
Query for report types based on the entity that initiated report creation. | Value | Description | |------------|----------------------------------------------…
ReportRequest
object
5 properties
5 required
fx_spot_rate
number
[Sender only] The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source.
destination_result_proceeds
number
[Receiver only] Amount of fiat currency received for payout without fee.
balance_result
number
Account balance after the transaction.
remitter_name
string
Complete name of the person originating the payment. Note: Values are only viewable by the customer requesting the report.
payment_state
string
The state of a payment at the moment it is queried.
ReportFormatEnum
string
The report format of the downloadable report.
source_result_adjusted_amount
number
Fiat amount after deduction of source exchange fee.
ReportsMetadataResponse
object
1 property
1 required
payment_method
string
[Sender only] Method for completing the payment. This is a freeform text field that accepts custom strings for payment methods, for example: - CSMIDIDR - MSISD…
fx_rate
number
The foreign exchange rate associated with the failure conversion transaction.
withdrawal_result_amount
number
[Sender only] Final amount of XRP at sourceexchange wallet to be withdrawn after withdrawalresultfeeamount fees and withdrawalresultincentivevalue incentives h…
transaction_state
string
The transaction state of the overall payment when it's queried.
balance_change_currency
string
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code associated with the transaction account.
withdrawal_result_id
string
[Sender only] Unique identifier for the withdrawal transaction at the sourceexchange.
transfer_currency
string
The three-letter code of the currency associated with this transfer.
withdrawal_result_fee_amount
number
[Sender only] Withdrawal fee charged by the sourceexchange. This is substracted from the total withdrawalresultamount.
ssa_remote_transfer_id
string
The unique identifier of the SSA transfer from the SSA funding account to the SSA account.
ssa_account
string
The SSA account name and address of the sender in accountname@ripplenetaddress format.
destination_result_amount
number
[Receiver only] The final XRP amount at destination wallet to be liquidated into received fiat currency.
sent_amount
number
The payment amount sent.
received_currency
string
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the receivedamount.
sent_currency
string
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the of sentamount.
FailureConversionSsaTransaction
object
These are the data fields for the FAILURECONVERSIONSSA report you download from the [Get a report](/products/payments-odl/api-docs/reportservice/reference/open…
21 properties
destination_result_incentive_value
number
The incentive value (XRP) to be added into the total destinationresultamount.
source_result_amount
number
Fiat amount before deduction of source exchange fee.
beneficiary_account
string
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
Unique identifier for a batch of payments. Note: This field is only populated for payments that are part of a batch.
withdrawal_result_details_transaction_id
string
XRP transaction hash if there is on-ledger movement.
liquidation_status
string
Reserved for future use.
balance_change
number
The change in account balance caused by the corresponding transaction.
receiver_customer
string
Name of the receiving institution.
ReportCreatedBy
string
Identifies the entity that initiated the report creation. | Value | Description | |-------------|----------------------------------------------------| | SCHEDU…
end_to_end_id
string
The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment.
ReportMetadata
object
9 properties
6 required
destination_result_adjusted_amount
number
[Receiver only] The final XRP amount at destination wallet to be liquidated including fees.
ripplenet_payment_id
string
The unique payment identifier.
liquidation_trade_request_status
string
Reserved for future use.
receiver_address
string
RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress.
source_result_adjusted_proceeds
number
XRP amount after deduction of the conversion fees from sourceresultproceeds.
transaction_id
string
Unique identifier of the balance change between two accounts.
remitter_account
string
Account number at the sending institution for the payment remitter. Note: Values are only viewable by the customer requesting the report.
sender_customer
string
The name of the sending institution.
destination_exchange
string
[Receiver only] The destination exchange for the payment.
transaction_type
string
The type of transaction.
report_name
string
User defined name of the report.
destination_result_adjusted_proceeds
number
Amount of fiat currency received for payout including fees.
ssa_balance_result
number
The SSA account balance after the transaction is complete.
PaymentOpsReportTransaction
object
These are the data fields for the PAYMENTOPS report you download from the [Get a report](/products/payments-odl/api-docs/reportservice/reference/openapi/report…
24 properties
ReportTypeEnum
string
The report type of the downloadable report.
ssa_transfer_state
string
The state of the SSA transfer.
destination_result_id
string
Unique identifier for the destination trade at the destinationexchange.
intermediary_delta
number
report_created_on
string
Report creation time
deposit_result_fee_amount
number
[Receiver only] Deposit fee charged in XRP by the destinationexchange.
source_result_proceeds
number
XRP amount after exchange of the sourceresultadjustedamount at the sourceexchange.
ReportDownloadRecordLink
object
10 properties
6 required
received_amount
number
The payment amount received by the beneficiary.
source_exchange
string
[Sender only] The source exchange where the sender originates the payment.
ssa_transfer_amount
number
The SSA transfer amount.
beneficiary_name
string
Complete name of the person receiving the payment. Note: Values are only viewable by the customer requesting the report.
ssa_balance_change
number
The change in SSA balance caused by the corresponding transaction.
deposit_result_amount
number
[Receiver only] The total amount of XRP deposited into the destination wallet. Must equal withdrawalresultamount, minus negligible ledger fees.
ErrorResponse
object
5 properties
4 required
execution_result_type
string
The type of failure conversion transaction.
internal_payment_state
string
[Ripple internal] Ripple uses this information for troubleshooting purposes.
deposit_result_id
string
[Receiver only] Unique identifier for the deposit at the destinationexchange.
ReportStatusEnum
string
The status of the report.
venue_id
string
The unique identifier associated with a transaction involving an exchange account. Sometimes it's called "exchange id" or "order id".
ReconciliationReportTransaction
object
These are the data fields for the RECON report you download from the [Get a report](/products/payments-odl/api-docs/reportservice/reference/openapi/reports/get…
46 properties
ReportRecord
object
8 properties
6 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Ripple Labs publishes across the network.
