Transaction

Get Transaction Status

Returns overall transaction status and all of its known payloads based on supplied intent hash.

post/transaction/status

Request body

intent_hashstring required

Bech32m-encoded hash.

Example request

{
  "intent_hash": "<transaction-intent-hash>"
}

Response

Transaction Status

status'Unknown' | 'CommittedSuccess' | 'CommittedFailure' | 'Pending' | 'Rejected' required

A top-level intent status, left in for backwards compatibility. It doesn't give much information. Rejected means PermanentRejection.

A more specific intent status. See the description field for further information. Note that CommitPendingOutcomeUnknown can either result in CommittedSuccess or CommittedFailure.

intent_status_descriptionstring required

An additional description to clarify the intent status.

committed_state_versioninteger nullable

If the intent was committed, this gives the state version when this intent was committed.

permanently_rejects_at_epochinteger nullable

The epoch number at which the transaction is guaranteed to get permanently rejected by the Network due to exceeded epoch range defined when submitting transaction.

error_messagestring nullable

The most relevant error message received, due to a rejection or commit as failure. Please note that presence of an error message doesn't imply that the intent will definitely reject or fail. This could represent a temporary error (such as out of fees), or an error with a payload which doesn't end up being committed.

Example response

{
  "ledger_state": {
    "network": "<network-name>"
  }
}

Changes

Changed in 2 of the 50 revisions of this API.51

Dec 10, 202400c5f3bf5c215See the full diff
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
May 14, 20247601c23b1af11See the full diff
- ○
  added AccountLockerNotFoundError discriminator mapping keys to the response property for the response status
  response-property-discriminator-mapping-added

Full history