List Transactions

Fetch a list of transactions, sorted by the date they were created from newest to oldest.

GET/transactions

This endpoint fetches a list of all the transactions Stedi has processed in your account. It's useful for displaying a list of transactions in a UI. If you want to programmatically fetch and check for new transactions, you should use the Poll Transactions endpoint instead.

Authorization
RequiredHeader

A Stedi API Key for authentication.

Query Parameters

pageSize
NumberRange: ≥ 1 and ≤ 500

The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.

pageToken
StringLength: 1 - 1024

A token returned by a previous call to this operation in the nextPageToken. If not specified, Stedi returns the first page of results.

List only transactions containing a business identifier with the given value.

Any valid 3-digit X12 Transaction Set Identifier Code, as defined in the X12 standard. See: https://www.stedi.com/edi/x12/element/143.

Possible values
100
101
102
103
104
sender
String

List only transactions sent by the given profile. This is the profile ID of the sender.

receiver
String

List only transactions sent to the given profile. This is the profile ID of the receiver.

direction
String

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
mode
String

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
status
String

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

Possible values
failed
succeeded
from
StringFormat: date-time

The start of the time range to filter transactions. The results will include transactions created at or after this timestamp.

to
StringFormat: date-time

The end of the time range to filter transactions. The results will include transactions up to and including this timestamp.

elementId
String

List only transactions containing a business identifier with the given element ID. This is the X12 element ID, such as "127" for Reference Identification. May only be supplied if businessIdentifier is also supplied. See Stedi's EDI references pages to find element IDs.

List only transactions that were sent or received on the given partnership. This is the partnership ID, such as "local_clearinghouse-test".

Response

application/json

ListTransactions 200 response

nextPageToken
StringLength: 1 - 1024

Token for pagination to retrieve the next page of results; null if there are no more results

items
Array of ObjectsRequired

The processed transactions that match the request criteria. The items array is empty if there are no matching transactions.

Array item
transactionId
items[].transactionId
StringRequired

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 portal.

fileExecutionId
items[].fileExecutionId
StringRequired

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.

status
items[].status
StringRequired

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

Possible values
failed
succeeded
direction
items[].direction
StringRequired

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
mode
items[].mode
StringRequired

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
processedAt
items[].processedAt
StringRequiredFormat: date-time

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

artifacts
items[].artifacts
Array of ObjectsRequired

A list of artifacts related to the transaction.

Array item
artifactType
items[].artifacts[].artifactType
StringRequired

The format of the artifact.

Possible values
text/csv
application/edifact
application/filepart
application/json
application/pdf
usage
items[].artifacts[].usage
StringRequired

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
sizeBytes
items[].artifacts[].sizeBytes
NumberRequired

The size of the artifact in bytes.

url
items[].artifacts[].url
StringRequired

A URL to download the artifact.

model
items[].artifacts[].model
StringRequired

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
partnership
items[].partnership
ObjectRequired

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. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.

Show attributes
partnershipId
items[].partnership.partnershipId
StringRequiredRegex pattern: ^([a-zA-Z0-9._-]+)$Length: 1 - 81

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. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnerships for you automatically when you set up your account.

partnershipType
items[].partnership.partnershipType
StringRequired

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

Possible values
x12
edifact
sender
items[].partnership.sender
ObjectRequired

The entity that initiated the transaction.

Show attributes
profileId
items[].partnership.sender.profileId
StringRequiredRegex pattern: ^([a-zA-Z0-9._-]+)$Length: 1 - 40

A unique identifier for the profile within the Stedi platform.

receiver
items[].partnership.receiver
ObjectRequired

The entity that is receiving the transaction.

Show attributes
profileId
items[].partnership.receiver.profileId
StringRequiredRegex pattern: ^([a-zA-Z0-9._-]+)$Length: 1 - 40

A unique identifier for the profile within the Stedi platform.

x12
items[].x12
Object

Details about the X12 EDI transaction.

Show attributes
metadata
items[].x12.metadata
ObjectRequired

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
interchange
items[].x12.metadata.interchange
ObjectRequired

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

Show attributes
acknowledgmentRequestedCode
items[].x12.metadata.interchange.acknowledgmentRequestedCode
StringRequired

The value of ISA14 in the Interchange Control Header, which indicates whether the sender is requesting a TA1 Interchange Acknowledgment.

controlNumber
items[].x12.metadata.interchange.controlNumber
NumberRequiredRange: ≥ 0 and ≤ 999999999

The control number in the Interchange Control Header.

functionalGroup
items[].x12.metadata.functionalGroup
ObjectRequired

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

Show attributes
controlNumber
items[].x12.metadata.functionalGroup.controlNumber
NumberRequiredRange: ≥ 0 and ≤ 999999999

The Group Control Number (GS06).

date
items[].x12.metadata.functionalGroup.date
StringRequired

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

functionalIdentifierCode
items[].x12.metadata.functionalGroup.functionalIdentifierCode
StringRequired

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

time
items[].x12.metadata.functionalGroup.time
StringRequired

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

release
items[].x12.metadata.functionalGroup.release
StringRequired

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

transaction
items[].x12.metadata.transaction
ObjectRequired

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

Show attributes
controlNumber
items[].x12.metadata.transaction.controlNumber
StringRequired

The Transaction Set Control Number (ST02).

transactionSetIdentifier
items[].x12.metadata.transaction.transactionSetIdentifier
StringRequired

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

sender
items[].x12.metadata.sender
ObjectRequired

The Application Code and ISA ID for the profile.

Show attributes
applicationCode
items[].x12.metadata.sender.applicationCode
StringRequired

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

isa
items[].x12.metadata.sender.isa
ObjectRequired

The Interchange ID and qualifier.

Show attributes
qualifier
items[].x12.metadata.sender.isa.qualifier
StringRequired

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

id
items[].x12.metadata.sender.isa.id
StringRequired

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

receiver
items[].x12.metadata.receiver
ObjectRequired

The Application Code and ISA ID for the profile.

Show attributes
applicationCode
items[].x12.metadata.receiver.applicationCode
StringRequired

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

isa
items[].x12.metadata.receiver.isa
ObjectRequired

The Interchange ID and qualifier.

Show attributes
qualifier
items[].x12.metadata.receiver.isa.qualifier
StringRequired

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

id
items[].x12.metadata.receiver.isa.id
StringRequired

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

transactionSetting
items[].x12.transactionSetting
Object

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

Show attributes
guideId
items[].x12.transactionSetting.guideId
String

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.

transactionSettingId
items[].x12.transactionSetting.transactionSettingId
String

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. If you're using the Stedi clearinghouse, Stedi automatically configures the required transaction settings for you when you set up your account.

fragments
items[].fragments
Object

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

Show attributes
keyName
items[].fragments.keyName
StringRequired

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.

fragmentCount
items[].fragments.fragmentCount
NumberRequired

The total number of fragments in the transaction.

batchSize
items[].fragments.batchSize
NumberRequired

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

translationErrors
items[].translationErrors
Array of Objects

Details about errors that prevented Stedi from processing the transaction.

Array item
context
items[].translationErrors[].context
Object
Show attributes
code
items[].translationErrors[].context.code
String

The error code.

schemaPath
items[].translationErrors[].context.schemaPath
String

The name of the JSON property where the error occurred.

mark
items[].translationErrors[].mark
Object

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

Show attributes
start
items[].translationErrors[].mark.start
ObjectRequired
Show attributes
line
items[].translationErrors[].mark.start.line
NumberRequired

The line number in the document where the problem occurred.

column
items[].translationErrors[].mark.start.column
NumberRequired

The column number in the document where the problem occurred.

end
items[].translationErrors[].mark.end
Object
Show attributes
line
items[].translationErrors[].mark.end.line
NumberRequired

The line number in the document where the problem occurred.

column
items[].translationErrors[].mark.end.column
NumberRequired

The column number in the document where the problem occurred.

message
items[].translationErrors[].message
StringRequired

A message describing the error that occurred during translation.

businessIdentifiers
items[].businessIdentifiers
Array of Objects

Any business identifiers extracted from the transaction.

Array item
elementId
items[].businessIdentifiers[].elementId
StringRequired

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

element
items[].businessIdentifiers[].element
StringRequired

The element where the business identifier was found. For example, BHT03 for 837 claims.

name
items[].businessIdentifiers[].name
StringRequired

The friendly name of the business identifier. For example, Originator Application Transaction Identifier.

value
items[].businessIdentifiers[].value
StringRequired

The value of the business identifier.