Report data fields

View the data fields for the different report types.

Schemas

Payment operations

These are the data fields for the PAYMENT_OPS report you download from the Get a report operation. Use this report for high-level payment investigation and reporting.

end_to_end_idstring, [ 1 .. 128 ] characters

The unique ID that the sender specifies. It persists on all RippleNet instances that participate in the payment.

ripplenet_payment_idstring, [ 1 .. 128 ] characters

The unique payment identifier.

Example:"70eccd4f-abcd-1234-a655-3aeddff19e4a"

quote_tsstring, (date-time)

The ISO-8601 timestamp of the quote.

created_atstring, (date-time)

The ISO-8601 timestamp when the transaction was created.

Example:"2022-10-02T20:57:13.606Z"

executed_atstring, (date-time)

The ISO-8601 timestamp when the payment was settled.

Example:"2022-10-02T20:57:20.62Z"

sender_addressstring, [ 1 .. 128 ] characters

RippleNet account name and address of the sender, in the format accountname@ripplenetaddress.

Example:"new_york@rn.us.ny.new_york"

sender_customerstring, [ 1 .. 128 ] characters

The name of the sending institution.

Example:"examplecorp_sf"

sent_amountnumber

The payment amount sent.

Example:40

sent_currencystring, [ 1 .. 128 ] characters

The ISO 4217 currency code of the of sent_amount.

Example:"USD"

withdrawal_result_amountnumber

[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

receiver_addressstring, [ 1 .. 128 ] characters

RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress.

Example:"new_york@rn.us.ny.new_york"

receiver_customerstring, [ 1 .. 128 ] characters

Name of the receiving institution.

Example:"sf"

received_amountnumber

The payment amount received by the beneficiary.

Example:39.45

received_currencystring, [ 1 .. 128 ] characters

The ISO 4217 currency code of the received_amount.

Example:"PHP"

fx_spot_ratenumber

[Sender only]

The foreign exchange spot rate sourced from Refinitiv, CurrencyLayer, or another third-party source.

Example:58.70956379

source_exchangestring, [ 1 .. 128 ] characters

[Sender only]

The source exchange where the sender originates the payment.

Example:"bitstamp"

destination_exchangestring, [ 1 .. 128 ] characters

[Receiver only]

The destination exchange for the payment.

Example:"independentreserve"

payment_methodstring, [ 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:

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

Example:"CSM_TH_THB"

payment_statestring, [ 1 .. 128 ] characters

The state of a payment at the moment it is queried.

Example:"COMPLETED"

remitter_namestring, [ 1 .. 128 ] characters

Complete name of the person originating the payment.

Note: Values are only viewable by the customer requesting the report.

remitter_accountstring, [ 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_namestring, [ 1 .. 128 ] characters

Complete name of the person receiving the payment.

Note: Values are only viewable by the customer requesting the report.

beneficiary_accountstring, [ 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_idstring, [ 1 .. 36 ] characters

Unique identifier for a batch of payments.

Note: This field is only populated for payments that are part of a batch.

{
  "end_to_end_id": "string",
  "ripplenet_payment_id": "70eccd4f-abcd-1234-a655-3aeddff19e4a",
  "quote_ts": "2019-08-24T14:15:22Z",
  "created_at": "2022-10-02T20:57:13.606Z",
  "executed_at": "2022-10-02T20:57:20.62Z",
  "sender_address": "new_york@rn.us.ny.new_york",
  "sender_customer": "examplecorp_sf",
  "sent_amount": 40,
  "sent_currency": "USD",
  "withdrawal_result_amount": 39.846668,
  "receiver_address": "new_york@rn.us.ny.new_york",
  "receiver_customer": "sf",
  "received_amount": 39.45,
  "received_currency": "PHP",
  "fx_spot_rate": 58.70956379,
  "source_exchange": "bitstamp",
  "destination_exchange": "independentreserve",
  "payment_method": "CSM_TH_THB",
  "payment_state": "COMPLETED",
  "remitter_name": "string",
  "remitter_account": "string",
  "beneficiary_name": "string",
  "beneficiary_account": "string",
  "payment_batch_id": "string"
}