TransactionStatus

Transaction status. If the transaction was submitted, tx_json.hash and engine_result will be returned. Otherwise, they will be omitted.

Warning: XRP-API is early alpha software. API methods and data formats are likely to change frequently in ways that break backwards compatibility.

  • Type: Object

This type can contain the following fields:

Field Type Required? Description
engine_result String Optional Code indicating the preliminary result of the transaction, for example tesSUCCESS. Not final until included in a fully validated TransactionResult.
validated_ledger_index Integer Optional The ledger index of the latest validated ledger prior to submission. The earliest ledger index that the submitted transaction could appear in, as a result of this submission, is this value +1. Use this to bound your tx queries to find out the final status of this transaction. This is a validated ledger index because getting the latest current or closed ledger is not a guarantee—your transaction could make it into an earlier ledger index that also hasn't been validated yet.
engine_result_message String Optional Human-readable explanation of the transaction's preliminary result.
tx_blob String Optional The complete transaction in hex string format.
tx_json Object (Transaction JSON) Optional The complete transaction in rippled JSON format. If the transaction was submitted, get the transaction hash from here.
engine_result_code Integer Optional Numeric code indicating the preliminary result of the transaction, directly correlated to engine_result.