TransactionStatus

Transaction status returned immediately after submitting. If the transaction was submitted, tx_json.hash and engine_result will be included.

Warning: XAG-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
open_ledger_cost String Optional The current open ledger cost before processing this transaction. Transactions with a lower cost are likely to be queued.
accepted Boolean Optional The value true indicates that the transaction was applied, queued, broadcast, or kept for later. The value false indicates that none of those happened, so the transaction cannot possibly succeed as long as you do not submit it again and have not already submitted it another time. (Requires rippled v1.5.0+)
queued Boolean Optional The value true indicates the transaction was put in the Transaction Queue, which means it is likely to be included in a future ledger version.
account_sequence_next Number Optional The next Sequence Number for the sending account after all transactions that have been provisionally applied, but not transactions in the queue.
engine_result_code Integer Optional Numeric code indicating the preliminary result of the transaction, directly correlated to engine_result.
engine_result String Optional Code indicating the preliminary result of the transaction, for example tesSUCCESS. Not final until included in a fully validated TransactionResult.
tx_json Object (Transaction Common Fields) Optional The fields that are common to all transactions.
tx_blob String Optional The complete transaction in hex string format.
applied Boolean Optional The value true indicates that this transaction was applied to the open ledger. In this case, the transaction is likely, but not guaranteed, to be validated in the next ledger version.
broadcast Boolean Optional The value true indicates that this transaction was applied to the open ledger. In this case, the transaction is likely, but not guaranteed, to be validated in the next ledger version.
kept Boolean Optional The value true indicates that the transaction was kept to be retried later.
account_sequence_available Number Optional The next Sequence Number available for the sending account after all pending and queued transactions.
engine_result_message String Optional Human-readable explanation of the transaction's preliminary result.
validated_ledger_index Integer Optional The ledger index of the newest validated ledger at the time of submission. This provides a lower bound on the ledger versions that the transaction can appear in as a result of this request. (The transaction could only have been validated in this ledger version or earlier if it had already been submitted before.)