Get Transaction

Fetch details for a specific transaction.

GET/transactions/{transactionId}

This endpoint retrieves information about the transaction with the specified transactionId.

Authorizationstringrequiredheader

A Stedi API Key for authentication.

Path Parameters

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi app.

Response

application/json

GetTransaction 200 response

transactionIdstringrequired

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi app.

fileExecutionIdstringrequired

A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal.

statusstringrequired

A status indicating whether Stedi was able to successfully process the transaction.

Possible values
failed
succeeded
directionstringrequired

The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.

Possible values
INBOUND
OUTBOUND
UNKNOWN
modestringrequired

Indicates whether the transaction contains test or production data. Stedi determines this from the value in ISA15 Usage Indicator Code.

Possible values
test
production
other
processedAtstringrequired

The date and time when Stedi processed the transaction, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.

  • Format: date-time
artifactsarray<object>required

A list of artifacts related to the transaction.

Array item

The format of the artifact.

Possible values
text/csv
application/edifact
application/filepart
application/json
application/pdf
artifacts[].usagestringrequired

The type of data the artifact contains. For example, an input artifact represents the original data Stedi received before processing, while an output artifact represents the processed data.

For example, for an inbound 835 ERA from a payer, the input artifact would be the original X12 EDI, and the output artifact would be the JSON representation of the ERA.

Possible values
attachment
input
metadata
output
artifacts[].sizeBytesnumberrequired

The size of the artifact in bytes.

artifacts[].urlstringrequired

A URL to download the artifact.

artifacts[].modelstringrequired

The model of the artifact, which indicates the type of process or operation it represents. For example, an execution artifact represents a file that was processed, a fragment artifact represents a part of a larger transaction, and a fault artifact represents an error that occurred during processing.

Possible values
execution
fragment
transaction
fault
partnershipobjectrequired

Information about the associated partnership.

A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files.

Show attributes

The unique identifier for the partnership within the Stedi platform.

A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files.

  • Pattern: ^([a-zA-Z0-9._-]+)$
  • Required string length: 1 - 81

The type of partnership, which determines the EDI standard used for exchanging transactions.

Possible values
x12
edifact
partnership.senderobjectrequired

The entity that initiated the transaction.

Show attributes

A unique identifier for the profile within the Stedi platform.

  • Pattern: ^([a-zA-Z0-9._-]+)$
  • Required string length: 1 - 40
partnership.receiverobjectrequired

The entity that is receiving the transaction.

Show attributes

A unique identifier for the profile within the Stedi platform.

  • Pattern: ^([a-zA-Z0-9._-]+)$
  • Required string length: 1 - 40
x12object

Details about the X12 EDI transaction.

Show attributes
x12.metadataobjectrequired

Metadata about the X12 EDI transaction, including information from the interchange, functional group, and transaction headers as well as the sender and receiver IDs.

Show attributes

Data from the Interchange Control Header of the X12 EDI file.

Show attributes

The value of ISA14 in the Interchange Control Header, which indicates whether the sender is requesting an interchange acknowledgment.

The control number in the Interchange Control Header.

  • Range: ≥ 0 and ≤ 999999999

Data from the Functional Group Header of the X12 EDI file.

Show attributes

The Group Control Number (GS06).

  • Range: ≥ 0 and ≤ 999999999

The date in the Functional Group Header (GS04), formatted as YYYY-MM-DD. For example, 2023-08-28.

The Functional Identifier Code (GS01), which indicates the type of transaction. For example, HC for an 837 Healthcare Claim.

The Time (GS05), formatted as HH:MM:SS. For example, 21:29:57.

The Version/Release/Industry Identifier Code (GS08), which indicates the version of the X12 standard used. For example, 005010X222A1.

Data from the Transaction Set Header of the X12 EDI file.

Show attributes

The Transaction Set Control Number (ST02).

The Transaction Set Identifier Code (ST01), which indicates the type of transaction. For example, 837 for an 837 Healthcare Claim.

x12.metadata.senderobjectrequired

The Application Code and ISA ID for the profile.

Show attributes

The Application Code for the profile, which is used to identify the entity in the GS header of an EDI file.

The Interchange ID and qualifier.

Show attributes

The Interchange Sender ID Qualifier, which indicates the type of identifier. For example, ZZ for a mutually defined identifier.

The Interchange ID, which is the unique identifier for the entity in the EDI file.

x12.metadata.receiverobjectrequired

The Application Code and ISA ID for the profile.

Show attributes

The Application Code for the profile, which is used to identify the entity in the GS header of an EDI file.

The Interchange ID and qualifier.

Show attributes

The Interchange Sender ID Qualifier, which indicates the type of identifier. For example, ZZ for a mutually defined identifier.

The Interchange ID, which is the unique identifier for the entity in the EDI file.

The IDs for the guide and transaction setting Stedi used to process the transaction.

Show attributes

The unique identifier for the Stedi guide used to process the transaction.

Stedi guides are machine-readable specifications for X12 EDI transactions. They describe how to structure and validate EDI files for each transaction type.

The unique identifier for the transaction setting Stedi used to process the transaction.

Transaction settings configure how Stedi processes specific transaction types, such as which Stedi guide to use and other processing options.

fragmentsobject

Details about fragments included in the transaction, if applicable. Fragments break large transactions into smaller parts for easier processing and management.

Show attributes
fragments.keyNamestringrequired

The JSON schema key name for the segment in the Stedi guide used to split the transaction into fragments. For example, in an 834 Health Care Benefit Enrollment and Maintenance, this would be member_level_detail_INS_loop.

The total number of fragments in the transaction.

fragments.batchSizenumberrequired

The maximum size of each fragment in kilobytes (KB). Stedi uses this to automatically split large inbound transactions into fragments.

translationErrorsarray<object>

Details about errors that prevented Stedi from processing the transaction.

Array item
Show attributes

The name of the JSON property where the error occurred.

The location in the document where the problem occurred. May be a single index or a range.

Show attributes
Show attributes

The line number in the document where the problem occurred.

The column number in the document where the problem occurred.

Show attributes

The line number in the document where the problem occurred.

The column number in the document where the problem occurred.

A message describing the error that occurred during translation.

businessIdentifiersarray<object>

Any business identifiers extracted from the transaction.

Array item

The identifier of the element containing the business identifier in the EDI specification.

The element where the business identifier was found. For example, BEG-03.

The friendly name of the business identifier. For example, Purchase Order Number.

The value of the business identifier.