Retrieve Transaction

Fetch details for a specific transaction.

GET /transactions/{transactionId}

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

Authorizations

Authorization · Required Header

A Stedi API Key for authentication. Supports both test and production API keys.

Path Parameters

transactionId · String

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.

Response

application/json

transactionId · String Required

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 · String Required

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 · String Required

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

Possible values

failed

succeeded

direction · String Required

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 Required

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 · String Required Format : date-time

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

artifacts · Array of Objects Required

A list of artifacts related to the transaction.

partnership · Object Required

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.

x12 · Object

Details about the X12 EDI transaction.

fragments · Object

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

translationErrors · Array of Objects

Details about errors that prevented Stedi from processing the transaction.

businessIdentifiers · Array of Objects

Any business identifiers extracted from the transaction.

Request

curl --request GET \
  --url "https://core.us.stedi.com/2023-08-01/transactions/{transactionId}" \
  --header "Authorization: <api_key>"

Response

{
  "direction": "INBOUND",
  "mode": "test",
  "status": "succeeded",
  "fileExecutionId": "95236a56-a020-4522-8fef-bcffcec0ec1d",
  "transactionId": "c8dd3a67-b8ca-4b0e-aa73-e0de82414b8f",
  "processedAt": "2025-04-02T21:30:15.801Z",
  "artifacts": [
    {
      "artifactType": "application/edi-x12",
      "sizeBytes": 8374,
      "model": "transaction",
      "usage": "input",
      "url": "https://core.us.stedi.com/2023-08-01/transactions/c8dd1111-b8ca-4330e-aa73-e0de33314b8f/input"
    },
    {
      "artifactType": "application/json",
      "sizeBytes": 76898,
      "model": "transaction",
      "usage": "output",
      "url": "https://core.us.stedi.com/2023-08-01/transactions/c8dd3a67-b8ca-4b0e-kk73-55667882414b8f/output"
    }
  ],
  "partnership": {
    "partnershipId": "stedi_test-sender",
    "partnershipType": "x12",
    "sender": {
      "profileId": "test-sender"
    },
    "receiver": {
      "profileId": "stedi"
    }
  },
  "businessIdentifiers": [
    {
      "elementId": "127",
      "element": "BHT-03",
      "name": "Reference Identification",
      "value": "XXXXXX"
    }
  ],
  "x12": {
    "metadata": {
      "interchange": {
        "acknowledgmentRequestedCode": "0",
        "controlNumber": 1
      },
      "functionalGroup": {
        "controlNumber": 1,
        "release": "005010X222A1",
        "date": "2025-04-02",
        "time": "21:29:57",
        "functionalIdentifierCode": "HC"
      },
      "transaction": {
        "controlNumber": "0001",
        "transactionSetIdentifier": "837"
      },
      "receiver": {
        "applicationCode": "STEDI-TEST",
        "isa": {
          "qualifier": "ZZ",
          "id": "STEDI-TEST"
        }
      },
      "sender": {
        "applicationCode": "TestSender",
        "isa": {
          "qualifier": "ZZ",
          "id": "TestSender"
        }
      }
    },
    "transactionSetting": {
      "guideId": "01JQW6E5RSBSTKS3ZQ1SPR4019",
      "transactionSettingId": "01JQW6E72Q3HDXM40YYAQCBZDY"
    }
  }
}