Stedi Transactions API is one of 25 APIs that Stedi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
11 operations
across 11 paths,
and defines 49 schemas.
It is described by OpenAPI 3.2.0, at version 2023-08-01.
Requests are made against a single base URL, https://core.us.stedi.com/2023-08-01.
The identity and technical contract details declared by the specification.
X12TransactionMetadataTransaction
object
Data from the Transaction Set Header of the X12 EDI file.
2 properties
2 required
GetTransactionFragmentOutputDocumentResponseContent
object
1 property
X12TransactionSetIdentifierCode
string
Any valid 3-digit X12 Transaction Set Identifier Code, as defined in the X12 standard. See: .
GetTransactionResponseContent
object
12 properties
8 required
UnauthorizedExceptionResponseContent
object
The server response when the authorizer failed to authenticate the caller.
2 properties
1 required
ArtifactModel
string
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 proces…
ServiceExceptionResponseContent
object
2 properties
1 required
ArtifactUsage
string
The type of data the artifact contains. For example, an input artifact represents the original data Stedi received before processing, while an output artifact…
GetTransactionOutputDocumentUrlResponseContent
object
1 property
TransactionStatus
string
A status indicating whether Stedi was able to successfully process the transaction.
TransactionFragmentsSummary
object
Details about fragments included in the transaction, if applicable. Fragments break large transactions into smaller parts for easier processing and management.
3 properties
3 required
ResourceUnderChangeExceptionResponseContent
object
1 property
1 required
BadRequestExceptionResponseContent
object
The server cannot process the request due to an apparent client error.
2 properties
1 required
Index
object
2 properties
2 required
GetTransactionOutputDocumentResponseContent
object
1 property
X12TransactionMetadataInterchange
object
Data from the Interchange Control Header of the X12 EDI file.
2 properties
2 required
TransactionSummary
object
The processed transactions that match the request criteria. The items array is empty if there are no matching transactions.
12 properties
8 required
Mark
object
The location in the document where the problem occurred. May be a single index or a range.
2 properties
1 required
GatewayTimeoutExceptionResponseContent
object
The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
2 properties
1 required
X12TransactionMetadataProfile
object
The Application Code and ISA ID for the profile.
2 properties
2 required
PartnershipReceiver
object
The entity that is receiving the transaction.
1 property
1 required
GetTransactionInputDocumentResponseContent
object
1 property
ServiceUnavailableExceptionResponseContent
object
The server cannot handle the request due to technical reasons.
2 properties
1 required
ArtifactType
string
The format of the artifact.
UnprocessableEntityExceptionResponseContent
object
The request parameters do not match a previous request with the same idempotency key.
2 properties
1 required
X12TransactionMetadataFunctionalGroup
object
Data from the Functional Group Header of the X12 EDI file.
5 properties
5 required
X12TransactionSummary
object
Details about the X12 EDI transaction.
2 properties
1 required
GetTransactionAttachmentDocumentUrlResponseContent
object
1 property
Partnership
object
Information about the associated partnership. A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as w…
4 properties
4 required
PartnershipType
string
The type of partnership, which determines the EDI standard used for exchanging transactions.
X12TransactionMetadataProfileISA
object
The Interchange ID and qualifier.
2 properties
2 required
ThrottlingExceptionResponseContent
object
The server response when usage plan or account-level throttling limits exceeded.
2 properties
1 required
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…
X12TransactionSetting
object
The IDs for the guide and transaction setting Stedi used to process the transaction.
2 properties
ExceptionCause
object
3 properties
PartnershipSender
object
The entity that initiated the transaction.
1 property
1 required
X12TransactionMetadata
object
Metadata about the X12 EDI transaction, including information from the interchange, functional group, and transaction headers as well as the sender and receive…
5 properties
5 required
TranslationError
object
3 properties
1 required
BusinessIdentifier
object
4 properties
4 required
GetTransactionAttachmentDocumentResponseContent
object
1 property
GetTransactionFragmentOutputDocumentUrlResponseContent
object
1 property
ListTransactionsResponseContent
object
Common output structure for list operations with pagination support.
2 properties
1 required
GetTransactionFragmentResponseContent
object
11 properties
10 required
Artifact
object
5 properties
5 required
Mode
string
Indicates whether the transaction contains test or production data. Stedi determines this from the value in [ISA15 Usage Indicator Code](https://www.stedi.com/…
AccessDeniedExceptionResponseContent
object
The server response for authorization failure.
2 properties
1 required
GetTransactionInputDocumentUrlResponseContent
object
1 property
ResourceNotFoundExceptionResponseContent
object
The server response when the specified resource cannot be found after an API request passes authentication and authorization.
2 properties
1 required
TranslationErrorContext
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Stedi publishes across the network.
