Skip to main content
GET
Get a transaction

Overview

Returns the full TransactionSummary for a single transaction. This mirrors the Stedi SDK’s getTransaction and is convenient when you already hold a transactionId (for example from a poll) and want to refresh its details or fetch its artifact URLs without re-listing.

Authentication

JWT Bearer token from POST /api/token, with the api-access feature.

Path parameters

string
required
The transactionId returned by List Transactions or Poll Transactions.

Example

Response

Errors

Returns 404 ResourceNotFoundException when the transaction does not exist or is not owned by your organization. See the Transaction Stream Overview for the full error model.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

transactionId
string
required

Unique identifier of the processed transaction (the transactionId returned by the list/poll endpoints).

Response

The transaction summary.

A processed transaction, matching Stedi Core TransactionSummary.

transactionId
string
required

Unique transaction identifier.

fileExecutionId
string
required

Identifier of the file execution the transaction belongs to.

status
enum<string>
required
Available options:
succeeded,
failed
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND,
UNKNOWN
mode
enum<string>
required
Available options:
test,
production,
other
processedAt
string<date-time>
required

When the transaction was processed, ISO 8601. For uploaded / EOB-converted X12 this is the historical check date from the X12 GS04 header.

artifacts
object[]
required

Downloadable artifacts. Only input and output artifacts are returned; URLs point back at Cair.

partnership
object
required

The EDI partnership the transaction was exchanged on.

x12
object
fragments
object
translationErrors
object[]

Details about errors that prevented Cair from processing the transaction.

businessIdentifiers
object[]

Business identifiers extracted from the transaction.