EDI Transactions (Stedi-Compatible)

Get Transaction Output

Stedi Core-compatible Retrieve Transaction Output — the translated JSON document Cair produced (Guide JSON).

An authenticated call returns a 302 Found whose Location header and documentDownloadUrl body point at a short-lived, presigned download URL. Follow that URL (with or without the Authorization header) to stream the artifact; the presigned URL is valid for 60 minutes and is bound to your organization, the transaction, and the output usage.

GET

api

stedi

2023-08-01

transactions

{transactionId}

output

Get a transaction's output document

curl --request GET \
  --url https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{}

{
  "documentDownloadUrl": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output?token=0a1b2c3d4e5f60718293a4b5c6d7e8f9"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

Overview

Downloads the transaction’s output document — the translated JSON (Guide JSON) Cair produced from the input. This is a 1:1 drop-in for Stedi’s Retrieve Transaction Output operation and the Stedi SDK’s getTransactionOutput. For 835 remits the output is the parsed claim payment JSON; for 837 claims it is the parsed claim JSON. The Content-Type of the downloaded artifact is application/json.

Authentication

The initial request is authenticated with your JWT Bearer token from POST /api/token, with the api-access feature. The download request that follows the redirect is authenticated by the presigned token in the URL and does not require the Authorization header.

Path parameters

string

required

The transactionId whose output artifact you want to download.

Two-step download flow

Identical to the input endpoint:

Authenticated request. Call the endpoint with your Bearer token. Cair responds 302 Found with a Location header and a { "documentDownloadUrl": "..." } body.
Follow the redirect. Fetch the presigned URL — with or without the Authorization header — and Cair streams the JSON output artifact.

The presigned URL is valid for 60 minutes and is bound to your organization, the transaction, and the output usage.

Most SDKs and HTTP clients follow the 302 automatically, so getTransactionOutput typically returns the artifact bytes in a single call.

Example

curl -L "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -o transaction.json

const output = await fetch(
  `https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/${transactionId}/output`,
  { headers: { Authorization: `Bearer ${process.env.CAIR_ACCESS_TOKEN}` } },
);
const json = await output.json();

With the Stedi SDK:

const json = await stedi.core.getTransactionOutput('c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6');

Response

302 Found — body:

{
  "documentDownloadUrl": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output?token=0a1b2c3d4e5f60718293a4b5c6d7e8f9"
}

200 OK (after following the redirect) — the translated JSON artifact:

{
  "heading": {
    "payer_identification_N1_loop": {
      "payer_identification_N1": {
        "entity_identifier_code_01": "PR",
        "payer_name_02": "ACME HEALTH PLAN",
        "payer_identifier_04": "12345"
      }
    }
  },
  "detail": {
    "claim_payment_information_CLP": {
      "claim_submitter_identifier_01": "PCN123456",
      "claim_status_code_02": "1",
      "total_claim_charge_amount_03": "250.00",
      "claim_payment_amount_04": "200.00"
    }
  }
}

Errors

Status	Meaning
`401`	Missing/invalid Bearer token on the initial call, or an invalid/expired presigned token.
`404`	Transaction or output artifact not found, or not owned by your organization.

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

Raw output artifact bytes, returned when the presigned URL is followed. Content-Type matches the artifact (typically application/json).

The response is of type object.

Get a transaction's output document

curl --request GET \
  --url https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/{transactionId}/output")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{}

{
  "documentDownloadUrl": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output?token=0a1b2c3d4e5f60718293a4b5c6d7e8f9"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

Overview

API Authentication

Eligibility

Enrollments/Providers

Claims

EDI Transactions (Stedi-Compatible)

Claim AI Actions

Patient Chart Analysis

Patient Payments

Patients

Webhooks

AI Phone Calls

Get Transaction Output

Overview

Authentication

Path parameters

Two-step download flow

Example

Response

Errors

Authorizations

Path Parameters

Response

​Overview

​Authentication

​Path parameters

​Two-step download flow

​Example

​Response

​Errors

Authorizations

Path Parameters

Response

Overview

Authentication

Path parameters

Two-step download flow

Example

Response

Errors