Ripple Labs Reports API
The Report Service API provides `PAYMENT_OPS`, `RECON`, and `FAILURE_CONVERSION_SSA` reports in either CSV or JSON format.
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.0.0, at version 2.0.
Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.
5 operations
3 paths
75 schemas
1 DELETE3 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ripple Labs Reports API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (TokenAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Reports 5
The Report Service API provides PAYMENTOPS, RECON, and FAILURECONVERSIONSSA reports in either CSV or JSON format.
GET
/v1/reports
List reports
POST
/v1/reports
Create report
GET
/v1/reports/{report-id}
Get a report
DELETE
/v1/reports/{report-id}
Delete reports
GET
/v1/reports/download/{report-id}
Download a report
Schemas 75
The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are ReconciliationReportTransaction (46 properties), PaymentOpsReportTransaction (24 properties), FailureConversionSsaTransaction (21 properties), ReportDownloadRecordLink (10 properties). Each schema is shown below with its type and property counts.
withdrawal_result_amount
number
[Sender only] Final amount of XRP at sourceexchange wallet to be withdrawn after withdrawalresultfeeamount fees and withdrawalresultincentivevalue incentives h…
ReportDownloadRecordLink
object
10 properties
6 required
source_result_adjusted_proceeds
number
XRP amount after deduction of the conversion fees from sourceresultproceeds.
withdrawal_result_incentive_value
number
[Sender only] The incentive value in XRP applied to sourceresultproceeds to arrive at the withdrawalresultamount value.
destination_result_amount
number
[Receiver only] The final XRP amount at destination wallet to be liquidated into received fiat currency.
report_name
string
User defined name of the report.
receiver_address
string
RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress.
liquidation_status
string
Reserved for future use.
ReportRequest
object
5 properties
5 required
remitter_name
string
Complete name of the person originating the payment. Note: Values are only viewable by the customer requesting the report.
ssa_transfer_state
string
The state of the SSA transfer.
intermediary_delta
number
destination_exchange
string
[Receiver only] The destination exchange for the payment.
ssa_account
string
The SSA account name and address of the sender in accountname@ripplenetaddress format.
sender_customer
string
The name of the sending institution.
internal_payment_state
string
[Ripple internal] Ripple uses this information for troubleshooting purposes.
transaction_state
string
The transaction state of the overall payment when it's queried.
ssa_remote_transfer_id
string
The unique identifier of the SSA transfer from the SSA funding account to the SSA account.
received_amount
number
The payment amount received by the beneficiary.
ssa_transfer_currency
string
The three-letter code of the currency associated with this SSA transfer.
destination_result_adjusted_proceeds
number
Amount of fiat currency received for payout including fees.
withdrawal_result_details_transaction_id
string
XRP transaction hash if there is on-ledger movement.
CreatedByEnum
string
Query for report types based on the entity that initiated report creation. | Value | Description | |------------|----------------------------------------------…
balance_result
number
Account balance after the transaction.
sender_address
string
RippleNet account name and address of the sender, in the format accountname@ripplenetaddress.
ErrorResponse
object
5 properties
4 required
ripplenet_payment_id
string
The unique payment identifier.
transfer_currency
string
The three-letter code of the currency associated with this transfer.
payment_state
string
The state of a payment at the moment it is queried.
destination_result_proceeds
number
[Receiver only] Amount of fiat currency received for payout without fee.
received_currency
string
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the receivedamount.
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
withdrawal_result_fee_amount
number
[Sender only] Withdrawal fee charged by the sourceexchange. This is substracted from the total withdrawalresultamount.
ReportRecord
object
8 properties
6 required
transaction_type
string
The type of transaction.
destination_result_adjusted_amount
number
[Receiver only] The final XRP amount at destination wallet to be liquidated including fees.
ReportStatusEnum
string
The status of the report.
ReportTypeEnum
string
The report type of the downloadable report.
fx_rate
number
The foreign exchange rate associated with the failure conversion transaction.
withdrawal_result_id
string
[Sender only] Unique identifier for the withdrawal transaction at the sourceexchange.
ReportFormatEnum
string
The report format of the downloadable 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.
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…
beneficiary_name
string
Complete name of the person receiving the payment. Note: Values are only viewable by the customer requesting the report.
beneficiary_account
string
Account number at the receiving institution for the payment beneficiary. Note: Values are only viewable by the customer requesting the report.
fx_spot_rate
number
[Sender only] The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source.
venue_id
string
The unique identifier associated with a transaction involving an exchange account. Sometimes it's called "exchange id" or "order id".
execution_result_type
string
The type of failure conversion transaction.
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
deposit_result_id
string
[Receiver only] Unique identifier for the deposit at the destinationexchange.
ssa_transfer_amount
number
The SSA transfer amount.
source_exchange
string
[Sender only] The source exchange where the sender originates the payment.
report_created_on
string
Report creation time
source_result_adjusted_amount
number
Fiat amount after deduction of source exchange fee.
deposit_result_amount
number
[Receiver only] The total amount of XRP deposited into the destination wallet. Must equal withdrawalresultamount, minus negligible ledger fees.
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
ssa_balance_change
number
The change in SSA balance caused by the corresponding transaction.
source_result_amount
number
Fiat amount before deduction of source exchange fee.
sent_amount
number
The payment amount sent.
end_to_end_id
string
The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment.
liquidation_trade_request_status
string
Reserved for future use.
receiver_customer
string
Name of the receiving institution.
sent_currency
string
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the of sentamount.
balance_change
number
The change in account balance caused by the corresponding transaction.
remitter_account
string
Account number at the sending institution for the payment remitter. Note: Values are only viewable by the customer requesting the report.
destination_result_id
string
Unique identifier for the destination trade at the destinationexchange.
deposit_result_fee_amount
number
[Receiver only] Deposit fee charged in XRP by the destinationexchange.
ReportCreatedBy
string
Identifies the entity that initiated the report creation. | Value | Description | |-------------|----------------------------------------------------| | SCHEDU…
destination_result_incentive_value
number
The incentive value (XRP) to be added into the total destinationresultamount.
balance_change_currency
string
The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code associated with the transaction account.
ReportsMetadataResponse
object
1 property
1 required
source_result_proceeds
number
XRP amount after exchange of the sourceresultadjustedamount at the sourceexchange.
transaction_id
string
Unique identifier of the balance change between two accounts.
ssa_balance_result
number
The SSA account balance after the transaction is complete.
ReportMetadata
object
9 properties
6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ripple Labs 12
Other APIs Ripple Labs publishes across the network.
Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
#Reports