Stedi Remittances API
The Remittances API from Stedi — 2 operation(s) for remittances.
The Remittances API from Stedi — 2 operation(s) for remittances.
openapi: 3.0.3
info:
contact:
email: healthcare@stedi.com
license:
name: Proprietary
url: https://stedi.com
title: Stedi Healthcare Claims Claim acknowledgments Remittances API
version: '2025-03-07'
servers:
- description: Production
url: https://claims.us.stedi.com/2025-03-07
security:
- httpApiKeyAuth: []
tags:
- name: Remittances
paths:
/change/medicalnetwork/reports/v2/{transactionId}/835:
get:
description: Retrieve an 835 Electronic Remittance Advice (ERA) in JSON format
operationId: ConvertReport835
parameters:
- description: A unique identifier for the processed 835 transaction within Stedi. This ID is included in the transaction processed event, which you can receive automatically through Stedi [webhooks](https://www.stedi.com/docs/healthcare/configure-webhooks). You can also retrieve it through the [Poll Transactions endpoint](https://www.stedi.com/docs/healthcare/api-reference/get-poll-transactions) or from the transaction's details page within the Stedi portal.
examples:
ConvertReport835_example1:
description: ''
summary: Retrieve 835 ERA
value: d567c2ae-f073-4725-8b8c-06c473b738a6
in: path
name: transactionId
required: true
schema:
description: A unique identifier for the processed 835 transaction within Stedi. This ID is included in the transaction processed event, which you can receive automatically through Stedi [webhooks](https://www.stedi.com/docs/healthcare/configure-webhooks). You can also retrieve it through the [Poll Transactions endpoint](https://www.stedi.com/docs/healthcare/api-reference/get-poll-transactions) or from the transaction's details page within the Stedi portal.
maxLength: 36
minLength: 36
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
responses:
'200':
content:
application/json:
examples:
ConvertReport835_example1:
description: ''
summary: Retrieve 835 ERA
value:
meta:
applicationMode: production
senderId: BSW
transactionId: 7647d644-9348-4596-a3b4-6830b8b48cc8
transactions:
- controlNumber: '112233'
detailInfo:
- assignedNumber: '1'
paymentInfo:
- claimPaymentInfo:
claimFilingIndicatorCode: '12'
claimFrequencyCode: '1'
claimPaymentAmount: '500'
claimStatusCode: '1'
facilityTypeCode: '11'
patientControlNumber: '1112223333'
patientResponsibilityAmount: '300'
payerClaimControlNumber: '94060555410000'
totalClaimChargeAmount: '800'
claimSupplementalInformation:
coverageAmount: '800'
patientName:
firstName: JOHN
lastName: DOE
memberId: '1234567891'
serviceLines:
- lineItemControlNumber: '111222333'
serviceAdjustments:
- adjustmentAmount1: '300'
adjustmentReason1: Deductible Amount
adjustmentReasonCode1: '1'
claimAdjustmentGroupCode: PR
claimAdjustmentGroupCodeValue: Patient Responsibility
serviceDate: '20190301'
servicePaymentInformation:
adjudicatedProcedureCode: '99211'
lineItemChargeAmount: '800'
lineItemProviderPaymentAmount: '500'
productOrServiceIDQualifier: HC
productOrServiceIDQualifierValue: Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes
serviceSupplementalAmounts:
allowedActual: '800'
- claimPaymentInfo:
claimFilingIndicatorCode: '12'
claimFrequencyCode: '1'
claimPaymentAmount: '600'
claimStatusCode: '1'
facilityTypeCode: '11'
patientControlNumber: '22255566677'
patientResponsibilityAmount: '600'
payerClaimControlNumber: '9407779923000'
totalClaimChargeAmount: '1200'
claimSupplementalInformation:
coverageAmount: '1200'
patientName:
firstName: JANE
lastName: DOE
memberId: '1234567891'
serviceLines:
- serviceAdjustments:
- adjustmentAmount1: '600'
adjustmentReason1: Deductible Amount
adjustmentReasonCode1: '1'
claimAdjustmentGroupCode: PR
claimAdjustmentGroupCodeValue: Patient Responsibility
serviceDate: '20190310'
servicePaymentInformation:
adjudicatedProcedureCode: '93555'
lineItemChargeAmount: '1200'
lineItemProviderPaymentAmount: '600'
productOrServiceIDQualifier: HC
productOrServiceIDQualifierValue: Health Care Financing Administration Common Procedural Coding System (HCPCS) Codes
serviceSupplementalAmounts:
allowedActual: '1200'
financialInformation:
checkIssueOrEFTEffectiveDate: '20190316'
creditOrDebitFlagCode: C
payerIdentifier: '000000000'
paymentFormatCode: CCP
paymentMethodCode: ACH
receiverAccountDetails:
receiverAccountNumber: '144444'
receiverAccountNumberQualifier: DA
receiverDfiIdNumberQualifier: '01'
receiverDfiIdentificationNumber: '111333555'
senderAccountDetails:
senderAccountNumber: '11111111'
senderAccountNumberQualifier: DA
senderDFIIdentifier: '888999777'
senderDfiIdNumberQualifier: '01'
totalActualProviderPaymentAmount: '1100'
transactionHandlingCode: I
payee:
federalTaxPayersIdentificationNumber: '777667755'
name: ACME MEDICAL CENTER
npi: '1999999984'
payer:
address:
address1: 10 SOUTH AVENUET
city: NEW YORK
postalCode: '55111'
state: SD
name: RUSHMORE LIFE
technicalContactInformation:
- contactMethods:
- phone: '8005550000'
contactName: JOHN DOE
paymentAndRemitReassociationDetails:
checkOrEFTTraceNumber: '71700666555'
originatingCompanyIdentifier: '1935665544'
traceTypeCode: '1'
productionDate: '20190314'
schema:
$ref: '#/components/schemas/ConvertReport835ResponseContent'
description: ConvertReport835 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationExceptionResponseContent'
description: ValidationException 400 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
description: AccessDeniedException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
description: ResourceNotFoundException 404 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
description: ThrottlingException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureExceptionResponseContent'
description: InternalFailureException 500 response
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
description: ServiceUnavailableException 503 response
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
description: GatewayTimeoutException 504 response
tags:
- Remittances
/electronic-remittance-advice/{transactionId}/pdf:
get:
description: Retrieve the generated PDF of an 835 Electronic Remittance Advice (ERA).
operationId: GetElectronicRemittanceAdvicePdf
parameters:
- description: A unique identifier for the Electronic Remittance Advice (ERA) within Stedi. This ID is included in the transaction processed event for the ERA, which you can receive automatically through Stedi [webhooks](https://www.stedi.com/docs/healthcare/configure-webhooks). You can also retrieve this ID through the [Poll Transactions endpoint](https://www.stedi.com/docs/healthcare/api-reference/get-poll-transactions) or from the transaction's details page within Stedi.
examples:
GetElectronicRemittanceAdvicePdf_example1:
description: ''
summary: Retrieve PDF
value: b12a1241-3312-a3dc-aed2-1a30ca50cd63
in: path
name: transactionId
required: true
schema:
description: A unique identifier for the Electronic Remittance Advice (ERA) within Stedi. This ID is included in the transaction processed event for the ERA, which you can receive automatically through Stedi [webhooks](https://www.stedi.com/docs/healthcare/configure-webhooks). You can also retrieve this ID through the [Poll Transactions endpoint](https://www.stedi.com/docs/healthcare/api-reference/get-poll-transactions) or from the transaction's details page within Stedi.
maxLength: 36
minLength: 36
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
- description: If false, the generated PDF will not include the Stedi logo in the footer. The default is true.
in: query
name: logo
schema:
description: If false, the generated PDF will not include the Stedi logo in the footer. The default is true.
type: boolean
responses:
'200':
content:
application/pdf:
examples:
GetElectronicRemittanceAdvicePdf_example1:
description: ''
summary: Retrieve PDF
value: '%PDF-1.3
1 0 obj<< ...'
schema:
$ref: '#/components/schemas/GetElectronicRemittanceAdvicePdfOutputPayload'
description: GetElectronicRemittanceAdvicePdf 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationExceptionResponseContent'
description: ValidationException 400 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
description: AccessDeniedException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
description: ResourceNotFoundException 404 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingExceptionResponseContent'
description: ThrottlingException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureExceptionResponseContent'
description: InternalFailureException 500 response
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
description: ServiceUnavailableException 503 response
'504':
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
description: GatewayTimeoutException 504 response
tags:
- Remittances
components:
schemas:
ReceiverAccountDetails:
description: Financial institution account details for the payment receiver.
properties:
receiverAccountNumber:
description: The provider's account number.
type: string
receiverAccountNumberQualifier:
$ref: '#/components/schemas/AccountNumberQualifier'
description: The code identifying the type of account. Can be either `DA` - Demand Deposit or `SA` - Savings.
receiverDfiIdNumberQualifier:
$ref: '#/components/schemas/DfiIdNumberQualifier'
description: The code identifying the type of identification number of the Depository Financial Institution (DFI). Can be either `01` - ABA Transit Routing Number Including Check Digits (9 digits) or `04` - Canadian Bank Branch Institution Number.
receiverDfiIdentificationNumber:
description: The identification number specified in `receiverDfiIdNumberQualifier`.
type: string
type: object
PaymentFormatCode:
description: Identifies the specific electronic payment format used for ACH transactions. These formats determine the structure and content of the electronic payment message.
enum:
- CCP
- CTX
type: string
PaymentInfoClaimSupplementalInformation:
description: Additional information about the claim payment. All values are expressed as decimals.
properties:
coverageAmount:
description: The total covered charges. This is the sum of the original submitted provider charges that are considered for payment under the health plan. This excludes charges considered not covered, but includes reductions to payments of covered services, such as patient deductibles.
type: string
discountAmount:
description: This is the Prompt Pay Discount Amount.
type: string
federalMedicareOrMedicaidPaymentMandateCategory1:
description: Federal Medicare or Medicaid Payment Mandate - Category 1.
type: string
federalMedicareOrMedicaidPaymentMandateCategory2:
description: Federal Medicare or Medicaid Payment Mandate - Category 2.
type: string
federalMedicareOrMedicaidPaymentMandateCategory3:
description: Federal Medicare or Medicaid Payment Mandate - Category 3.
type: string
federalMedicareOrMedicaidPaymentMandateCategory4:
description: Federal Medicare or Medicaid Payment Mandate - Category 4.
type: string
federalMedicareOrMedicaidPaymentMandateCategory5:
description: Federal Medicare or Medicaid Payment Mandate - Category 5.
type: string
interest:
description: The interest amount.
type: string
negativeLedgerBalance:
description: The negative ledger balance. Only used by Medicare Part A and Medicare Part B.
type: string
patientAmountPaid:
description: The amount the patient has already paid.
type: string
perDayLimit:
description: The per day limit.
type: string
tax:
description: The total taxes.
type: string
totalClaimBeforeTaxes:
description: The total claim amount before taxes.
type: string
type: object
ClaimPaymentAdviceServiceLinesRenderingProviderInformation:
description: Identifiers for the provider who rendered this service.
properties:
blueCrossProviderNumber:
description: The rendering provider's Blue Cross Provider Number.
type: string
blueShieldProviderNumber:
description: The rendering provider's Blue Shield Provider Number.
type: string
champusIdentificationNumber:
description: The rendering provider's CHAMPUS Identification Number.
type: string
facilityIdNumber:
description: The rendering provider's Facility ID Number.
type: string
federalTaxpayerIdentificationNumber:
description: The rendering provider's Federal Taxpayer Identification Number.
type: string
medicaidProviderNumber:
description: The rendering provider's Medicaid Provider Number.
type: string
medicareProviderNumber:
description: The rendering provider's Medicare Provider Number.
type: string
nationalCouncilForPrescriptionDrugProgramPharmacyNumber:
description: The rendering provider's National Council for Prescription Drug Programs Pharmacy Number.
type: string
npi:
description: The rendering provider's National Provider Identifier (NPI).
pattern: ^\d{10}$
type: string
providerCommercialNumber:
description: The Provider Commercial Number.
type: string
providerUPINNumber:
description: Deprecated; replaced by NPI in 2007.
type: string
ssn:
description: The rendering provider's Social Security Number (SSN).
pattern: ^\d{9}$
type: string
stateLicenseNumber:
description: The rendering provider's State License Number.
type: string
type: object
Meta:
description: Metadata that helps Stedi track and debug the response.
properties:
applicationMode:
description: Whether this is a test or production ERA.
type: string
senderId:
description: An identifier for the most recent sender of the ERA. This is usually not the original sender, so this value is unlikely to be a payer ID. When Stedi processes and delivers ERAs through the clearinghouse, this value is always `STEDI`.
type: string
traceId:
description: Not currently used.
type: string
transactionId:
description: The Stedi transaction identifier.
maxLength: 36
minLength: 36
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
type: object
ProviderSupplementalSummaryInformation:
description: Additional summary information about the provider and the charges in the claim. All values are expressed as decimals.
properties:
averageDRGLengthOfStay:
description: The average length of stay for diagnosis related group (DRG) claims.
type: string
averageDRGWeight:
description: The average diagnosis-related group (DRG) weight.
type: string
totalCapitalAmount:
description: 'The total capital amount. This includes: capital federal-specfic amount, hospital federal-specfic amount, hold harmless amount, Indirect Medical Education amount, Disproportionate Share Hospital amount, and the exception amount. It does not include any capital outlier amount.'
type: string
totalCostOutlierAmount:
description: The total cost outlier amount.
type: string
totalCostReportDayCount:
description: The total number of cost report days.
type: string
totalCoveredDayCount:
description: The total number of covered days.
type: string
totalDRGAmount:
description: The total of the charges reported for all diagnosis-related group (DRG) codes.
type: string
totalDayOutlierAmount:
description: The total day outlier amount.
type: string
totalDischargeCount:
description: The total number of discharges.
type: string
totalDisproportionateShareAmount:
description: The total disproportionate share amount.
type: string
totalFederalSpecificAmount:
description: The total federal specific amount.
type: string
totalHospitalSpecificAmount:
description: The total hospital specific amount.
type: string
totalIndirectMedicalEducationAmount:
description: The total indirect medical education amount.
type: string
totalMSPPassThroughAmount:
description: The total Medicare Secondary Payer (MSP) pass-through amount, calculated for a non-Medicare payer.
type: string
totalNonCoveredDayCount:
description: The total number of non-covered days.
type: string
totalOutlierDayCount:
description: The total number of outlier days.
type: string
totalPPSCapitalFSPDRGAmount:
description: The total prospective payment system (PPS) capital, federal-specific portion, diagnosis-related group (DRG) amount.
type: string
totalPPSCapitalHSPDRGAmount:
description: The total prospective payment system (PPS) capital, hospital-specific portion, diagnosis-related group (DRG) amount.
type: string
totalPPSDSHDRGAmount:
description: The total prospective payment system (PPS) disproportionate share, hospital diagnosis-related group (DRG) amount.
type: string
type: object
ClaimStatusCode:
description: Indicates the status of the claim after adjudication by the payer. These codes determine whether the claim was processed as primary, secondary, tertiary, denied, forwarded to other payers, or represents special processing situations like reversals or predeterminations.
enum:
- '1'
- '2'
- '3'
- '4'
- '19'
- '20'
- '21'
- '22'
- '23'
- '25'
type: string
DetailInfo:
description: Information about the claim or service line.
properties:
assignedNumber:
description: A unique ID assigned to identify this set of claim information within the response.
type: string
paymentInfo:
description: Information relevant to the claim and claim payment, including the subscriber, providers, and service lines. Note that the amount paid may not match the claim amount, even when the claim was not denied. This can happen for several reasons, including adjustments and corrected balances due from other claims.
items:
$ref: '#/components/schemas/PaymentInfo'
type: array
providerSummaryInformation:
$ref: '#/components/schemas/ProviderSummaryInformation'
description: Summary information about the provider.
providerSupplementalSummaryInformation:
$ref: '#/components/schemas/ProviderSupplementalSummaryInformation'
description: Supplemental summary information about the provider.
type: object
HealthCareCheckRemarkCodes:
description: Standard codes used to communicate informational remarks.
properties:
codeListQualifierCode:
description: Code identifying the specific industry code list containing the `remarkCode`. Can be `HE` - Claim Payment Remark Codes or `RX` - National Council for Prescription Drug Programs Reject/Payment Codes.
type: string
codeListQualifierCodeValue:
description: The description of the `codeListQualifierCode`. Can be `Claim Payment Remark Codes` or `National Council for Prescription Drug Programs Reject/Payment Codes`.
type: string
remark:
description: The human readable description of the remark code.
type: string
remarkCode:
description: 'The code identifying the specific remark.
This property can either be a [Remittance Advice Remark Code (RARC)](https://x12.org/codes/remittance-advice-remark-codes) (`codeListQualifierCode` set to `HE`) or a National Council for Prescription Drug Programs Reject/Payment Code (`codeListQualifierCode` set to `RX`).'
type: string
type: object
ServiceUnavailableExceptionResponseContent:
description: The server is temporarily unavailable.
properties:
code:
description: Classification of the exception type.
type: string
message:
description: Human readable exception message.
type: string
required:
- message
type: object
PaymentInfoInpatientAdjudication:
description: Information about the adjudication of inpatient claims.
properties:
claimDRGAmount:
description: The Diagnosis Related Group (DRG) amount.
type: string
claimDisproportionateShareAmount:
description: The Disproportionate Share amount.
type: string
claimIndirectTeachingAmount:
description: The indirect teaching amount.
type: string
claimMSPPassThroughAmount:
description: The Medicare Secondary Payer (MSP) pass-through amount.
type: string
claimPPSCapitalAmount:
description: The total Prospective Payment System (PPS) capital amount.
type: string
claimPPSCapitalOutlierAmount:
description: The Prospective Payment System (PPS) Capital Outlier amount.
type: string
claimPaymentRemarkCode1:
description: The [Claim Payment Remark Code](https://x12.org/codes/remittance-advice-remark-codes).
type: string
claimPaymentRemarkCode2:
description: A [Claim Payment Remark Code](https://x12.org/codes/remittance-advice-remark-codes).
type: string
claimPaymentRemarkCode3:
description: A [Claim Payment Remark Code](https://x12.org/codes/remittance-advice-remark-codes).
type: string
claimPaymentRemarkCode4:
description: A [Claim Payment Remark Code](https://x12.org/codes/remittance-advice-remark-codes).
type: string
claimPaymentRemarkCode5:
description: A [Claim Payment Remark Code](https://x12.org/codes/remittance-advice-remark-codes).
type: string
costReportDayCount:
description: The number of cost report days.
type: string
coveredDaysOrVisitsCount:
description: The number of days or visits covered by the health plan.
type: string
lifetimePsychiatricDaysCount:
description: The number of psychiatric days for the patient's lifetime.
type: string
nonPayableProfessionalComponentAmount:
description: The professional component amount billed but not payable.
type: string
oldCapitalAmount:
description: The old capital amount.
type: string
ppsCapitalDSHDRGAmount:
description: The Prospective Payment System (PPS) capital, disproportionate share, hospital Diagnosis Related Group (DRG) amount.
type: string
ppsCapitalExceptionAmount:
description: The capital exception amount.
type: string
ppsCapitalFSPDRGAmount:
description: The Prospective Payment System (PPS) capital, federal specific portion, Diagnosis Related Group (DRG) amount.
type: string
ppsCapitalHSPDRGAmount:
description: The Prospective Payment System (PPS) capital, hospital specific portion, Diagnosis Related Group (DRG), amount.
type: string
ppsCapitalIMEAmount:
description: The Prospective Payment System (PPS) capital indirect medical education claim amount.
type: string
ppsOperatingFederalSpecificDRGAmount:
description: The federal specific Diagnosis Related Group (DRG) amount.
type: string
ppsOperatingHospitalSpecificDRGAmount:
description: The hospital specific Diagnosis Related Group (DRG) Amount.
type: string
ppsOperatingOutlierAmount:
description: The Prospective Payment System (PPS) Operating Outlier amount, expressed as a decimal.
type: string
type: object
ProviderAdjustments:
description: Provider-level adjustments unrelated to specific claims.
properties:
adjustments:
description: List of adjustments applied to the provider.
items:
$ref: '#/components/schemas/Adjustments'
type: array
fiscalPeriodDate:
description: The last day of the provider's fiscal year.
pattern: ^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])$
type: string
providerIdentifier:
description: This is the provider's NPI.
type: string
type: object
TechnicalContactMethod:
description: Contact method details for technical support.
properties:
email:
description: The contact email address.
type: string
fax:
description: The contact fax number.
type: string
phone:
description: The contact telephone number including the area code. Phone numbers are formatted as AAABBBCCCC, where AAA represents the area code, BBB represents the telephone number prefix, and CCCC represents the telephone number. Phone numbers are provided without separators, such as dashes or parentheses. For example, `5551123345` for `555-112-3345`.
type: string
phoneExtension:
description: The contact telephone extension, if applicable.
type: string
url:
description: A web address to contact the person or entity. The URL is typically provided without the scheme and separator. For example, `stedi.com`.
type: string
type: object
CreditDebitFlagCode:
description: Indicates whether a financial transaction represents a credit or debit to the provider's account. Used to specify the direction of money flow in payment transactions.
enum:
- C
- D
type: string
ValidationExceptionResponseContent:
description: 'A standard error for input validation failures.
Thrown when a member of the input structure
falls outside of the modeled or documented constraints.'
properties:
code:
description: A code describing the type of validation failure.
type: string
message:
description: A message describing the causes of the validation failure. There may be more than one.
type: string
required:
- message
type: object
PayeeAddress:
description: Address information for the payee.
properties:
address1:
description: The first line of the address
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-remittances-api-openapi.yml