Remittance Data API overview

The Remittance Data API allows providers to search for and view electronic remittance advice (ERA) (also known as 835 data). This API gives trading partners secure access to ERAs that providers can review and maintain within billing software without requiring X12 connectivity. Users can search by check number or claim, and trading partners can convert the data to a PDF for easy downloading.

For more information about response fields and healthcare code sources, refer to the following ASC X12 Standards for Electronic Data Interchange Technical Report 3 (TR3): Health Care Claim Payment/Advice (835).

ERA enrollment

To use the Remittance Data API, you must enroll to receive electronic remittance advice (ERA) files through Availity Essentials. Follow these steps:

In the Availity Essentials navigation menu, select More > Payer List.
In the Search field, enter the full or partial payer name or payer ID and select Search.
Select a payer name to expand and review transaction details. If the Remittance Data API is supported for a payer, you will see Available under REST API.
If enrollment is required for the Claim Payment/Advice (835) transaction, select Enroll here in the Enrollment Required column on the payer’s card.
On the Transaction Enrollment - Enrollment Status page, select Enroll > Enroll a provider to enroll for the Claim Payment/Advice (835) transaction.

Endpoints


#	Path	Function
1.	POST/remittance-data-api/v1/checks/search	Search for remittances by check/EFT information. Can return multiple results.
2.	POST/remittance-data-api/v1/checks/details	Returns a full JSON object that can be used to create a PDF version of the check/EFT. If your request returns multiple checks, you must add more information in your request body to narrow your results.
3.	POST/remittance-data-api/v1/claims/search	Search for remittances by claim information. Can return multiple results.
4.	POST/remittance-data-api/v1/claims/details	Returns a full JSON object that can be used to create a PDF version of the claim. If your request returns multiple claims, you must add more information in your request body to narrow your results.
5.	POST/remittance-data-api/v1/checks/x12	Returns a full JSON object that can be used to create an X12 version of the check. If your request returns multiple checks, you must add more information in your request body to narrow your results.

Parameters

1. POST/remittance-data-api/v1/checks/search


POST/remittance-data-api/v1/checks/search request body
Object	Type	Definition
checkNumber	String	The number of the check/EFT.
checkAmount	String	The monetary amount of the check/EFT.
taxId	String	The provider's tax ID.
npi	String	The provider's National Provider Identifier.
organizationId	String	The unique number that Availity uses to identify your organization.
payerId	String	The payer's Availity-specific identifier.
checkDateFrom	String Required Date format: MM/DD/YYYY Date range limit: Two years	The beginning date range in which the check/EFT was issued.
checkDateTo	String Required Date format: MM/DD/YYYY Date range limit: Two years	The ending date range in which the check/EFT was issued.

2. POST/remittance-data-api/v1/checks/details


POST/remittance-data-api/v1/checks/details request body
Object	Type	Definition
checkNumber	String (Required)	The number of the check/EFT.
checkAmount	String	The monetary amount of the check/EFT.
taxId	String (Required)	The provider's tax ID.
npi	String	The provider's National Provider Identifier.
organizationId	String	The unique number that Availity uses to identify your organization.
payerId	String	The payer's Availity-specific identifier.
checkDateFrom	String Required Date format: MM/DD/YYYY Date range limit: Two years	The beginning date range in which the check/EFT was issued.
checkDateTo	String Required Date format: MM/DD/YYYY Date range limit: Two years	The ending date range in which the check/EFT was issued.

3. POST/remittance-data-api/v1/claims/search


POST/remittance-data-api/v1/claims/search request body
Object	Type	Definition
claimNumber	String	The number identifying the claim.
serviceDateFrom	String (Date format: MM/DD/YYYY)	The beginning date range for the services rendered in the claim.
serviceDateTo	String (Date format: MM/DD/YYYY)	The beginning date range for the services rendered in the claim.
totalPaidAmount	String	Total monetary amount paid for the claim.
totalChargeAmount	String	Total monetary amount charged for the claim.
checkNumber	String	The number of the check/EFT.
checkAmount	String	The monetary amount of the check/EFT.
taxId	String (Required)	The provider's tax ID.
npi	String	The provider's National Provider Identifier.
organizationId	String	The unique number that Availity uses to identify your organization.
payerId	String	The payer's Availity-specific identifier.
checkDateFrom	String Required Date format: MM/DD/YYYY Date range limit: Two years	The beginning date range in which the check/EFT was issued.
checkDateTo	String Required Date format: MM/DD/YYYY Date range limit: Two years	The ending date range in which the check/EFT was issued.

4. POST/remittance-data-api/v1/claims/details


POST/remittance-data-api/v1/claims/details request body
Object	Type	Definition
claimNumber	String (Required)	The number identifying the claim.
serviceDateFrom	String (Date format: MM/DD/YYYY)	The beginning date range for the services rendered in the claim.
serviceDateTo	String (Date format: MM/DD/YYYY)	The beginning date range for the services rendered in the claim.
totalPaidAmount	String	Total monetary amount paid for the claim.
totalChargeAmount	String	Total monetary amount charged for the claim.
checkNumber	String	The number of the check/EFT.
checkAmount	String	The monetary amount of the check/EFT.
taxId	String (Required)	The provider's tax ID.
npi	String	The provider's National Provider Identifier.
organizationId	String	The unique number that Availity uses to identify your organization.
payerId	String	The payer's Availity-specific identifier.
checkDateFrom	String Required Date format: MM/DD/YYYY Date range limit: Two years	The beginning date range in which the check/EFT was issued.
checkDateTo	String Required Date format: MM/DD/YYYY Date range limit: Two years	The ending date range in which the check/EFT was issued.

5. POST/remittance-data-api/v1/checks/x12


POST/remittance-data-api/v1/checks/x12 request body
Object	Type	Definition
checkNumber	String	The number of the check/EFT.
checkAmount	String	The monetary amount of the check/EFT.
taxId	String	The provider's tax ID.
npi	String	The provider's National Provider Identifier.
payerId	String	The payer's Availity-specific identifier.
checkDateFrom	String Required Date format: MM/DD/YYYY Date range limit: Two years	The beginning date range in which the check/EFT was issued.
checkDateTo	String Required Date format: MM/DD/YYYY Date range limit: Two years	The ending date range in which the check/EFT was issued.

Sample requests and responses

1. POST/remittance-data-api/v1/checks/search

Request:

curl --request POST \ 
  --url https://api.availity.com/remittance-data-api/v1/checks/search \ 
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ 
  --header 'accept: application/json' \ 
  --header 'content-type: application/json' \
  --data '{ 
   "checkNumber": "CHK123456",
   "checkAmount": 15420.50, 
   "taxId": "123456789", 
   "npi": "1234567890", 
   "organizationId": "12345678", 
   "payerId": "PAYR001", 
   "checkDateFrom": "01/01/2025", 
   "checkDateTo": "07/01/2025"
 }'

Response:

{
  "edges": [
    {
      "cursor": "abc123",
      "node": {
        "checkDate": "2025-03-15T00:00:00",
        "checkNumber": "CHK123456", 
        "checkAmount": 15420.50,
        "payerName": "ACME Health Insurance", 
        "payerPrimaryId": "12345", 
        "payeeName": "Example Medical Group", 
        "payeeNpi": "1234567890",
        "payeeTaxId": "123456789",
        "totalClaimCount": 3,
        "transactionType": "C:Payment Accompanies Remittance Advice", 
        "paymentMethodCd": "ACH",  
        "currencyCd": "USD", 
        "hasExternalEOB": false
       }
      }
     ],
     "pageInfo": { 
       "hasNextPage": false, 
       "hasPreviousPage": false, 
       "startCursor": "abc123", 
       "endCursor": "abc123"
      },
      "totalCount": 1,
      "edgeCount": 1
    }

2. POST/remittance-data-api/v1/checks/details

Request:

curl --request POST \
  --url https://api.availity.com/remittance-data-api/v1/checks/details \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
  "checkNumber": "CHK123456", 
  "checkAmount": 15420.50, 
  "taxId": "123456789", 
  "npi": "1234567890", 
  "organizationId": "12345678", 
  "payerId": "PAYR001", 
  "checkDateFrom": "01/01/2025", 
  "checkDateTo": "07/01/2025"
}'

Response:

{
    "checkSummary": {
      "checkDate": "2025-03-15T00:00:00",
      "checkNumber": "CHK123456", 
      "checkAmount": 15420.50,
      "payerName": "ACME Health Insurance", 
      "payerPrimaryId": "12345", 
      "payerPrimaryIdType": "XV", 
      "payerAddrLine1": "123 Insurance Blvd", 
      "payerCity": "Tampa",
      "payerState": "FL", 
      "payerZipCd": "33601", 
      "payerCountryCd": "US",
      "payeeName": "Example Medical Group", 
      "payeeId": "987654321",
      "payeeIdType": "XX", 
      "payeeNpi": "1234567890",
      "payeeTaxId": "123456789", 
      "payeeAddrLine1": "456 Provider St", 
      "payeeCity": "Orlando", 
      "payeeState": "FL",
      "payeeZipCd": "32801",
      "totalClaimCount": 3,
      "transactionType": "C:Payment Accompanies Remittance Advice",   
      "transactionHandlingCd": "C",
      "paymentMethodCd": "ACH", 
      "paymentFormatCd": "CCP", 
      "currencyCd": "USD",
      "productionDate": "2025-03-16T00:00:00", 
      "hasExternalEOB": false
    },
    "claimSummaries": [
      {
        "patientFullName": "DOE, JOHN", 
        "patientLastName": "DOE",
        "patientFirstName": "JOHN",
        "patientAccountNumber": "ACC-001", 
        "claimControlNumber": "2025031500001",
        "claimPaymentAmount": 5140.17,
        "totalClaimChargeAmount": 6500.00,
        "patientResponsibilityAmount": 250.00, 
        "claimFilingIndicatorCode": "MB", 
        "status": "1",
        "payeeName": "Example Medical Group", 
        "payeeNpi": "1234567890",
        "payeeTaxId": "123456789", 
        "payerLongName": "ACME Health Insurance", 
        "hasExternalEOB": false, 
        "hasMultipleEOBRemits": false
      }  
    ]
  }

Note: If your request returns data for more than one check/EFT, you will receive the following message:

Search returned multiple results. Please include more search criteria to reduce result set.

Add more information in your request body to narrow your results.

3. POST/remittance-data-api/v1/claims/search

Request:

curl --request POST \
  --url https://api.availity.com/availity/remittance-data-api/v1/claims/search \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
  "claimNumber": "2025031500001",
  "serviceDateFrom": "01/01/2025",
  "serviceDateTo": "07/01/2025",
  "totalPaidAmount": 5140.17,
  "totalChargeAmount": 6500.00,
  "checkNumber": "CHK123456",
  "checkAmount": 15420.50,
  "taxId": "123456789",
  "npi": "124567890",
  "organizationId": "1245678",
  "payerId": "PAYR001",
  "checkDateFrom": "01/01/2025",
  "checkDateTo": "07/01/2025"
}'

Response:

{
  "edges": [
    {
	"cursor": "def456", 
	"node": {
	  "checkDate": "2025-03-15T00:00:00",
        "checkNumber": "CHK123456", 
        "claimControlNumber": "2025031500001",
        "claimPaymentAmount": 5140.17, 
        "patientAccountNumber": "ACC-001", 
        "patientFirstName": "JOHN", 
        "patientFullName": "DOE, JOHN", 
        "patientLastName": "DOE", 
        "patientResponsibilityAmount": 250.00, 
        "payeeName": "Example Medical Group", 
        "payeeNpi": "1234567890",
        "payeeTaxId": "123456789", 
        "payerName": "ACME Health Insurance", 
        "subscriberFirstName": "JOHN", 
        "subscriberLastName": "DOE", 
        "totalClaimChargeAmount": 6500.00, 
        "hasExternalEOB": false
	}
    }
  ],
   "pageInfo": { 
    "hasNextPage": false, 
    "hasPreviousPage": false, 
    "startCursor": "def456", 
    "endCursor": "def456"
  },
  "totalCount": 1,
  "edgeCount": 1
}

4. POST/remittance-data-api/v1/claims/details

Request:

curl --request POST \ 
  --url https://api.availity.com/remittance-data-api/v1/claims/details \ 
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ 
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{ 
  "claimNumber": "2025031500001", 
  "serviceDateFrom": "01/01/2025",
  "serviceDateTo": "07/01/2025", 
  "totalPaidAmount": 5140.17, 
  "totalChargeAmount": 6500.00, 
  "checkNumber": "CHK123456", 
  "checkAmount": 15420.50, 
  "taxId": "123456789", 
  "npi": "1234567890", 
  "organizationId": "12345678", 
  "payerId": "PAYR001", 
  "checkDateFrom": "01/01/2025", 
  "checkDateTo": "07/01/2025"
 }'

Response:

{
  "patientFullName": "DOE, JOHN", 
  "patientLastName": "DOE", 
  "patientFirstName": "JOHN", 
  "patientAccountNumber": "ACC-001", 
  "claimControlNumber": "2025031500001",
  "claimPaymentAmount": 5140.17,
  "totalClaimChargeAmount": 6500.00,
  "patientResponsibilityAmount": 250.00, 
  "claimFilingIndicatorCode": "MB", 
  "status": "1",
  "transactionType": "C:Payment Accompanies Remittance Advice", 
  "paymentMethodCode": "ACH",
  "payeeName": "Example Medical Group", 
  "payeeNpi": "1234567890",
  "payeeTaxId": "123456789", 
  "payerLongName": "ACME Health Insurance", 
  "payerAddressLine1": "123 Insurance Blvd", 
  "payerCityStateZip": "Tampa, FL 33601", 
  "payerPhoneNumber": "8005551234", 
  "memberIdNumber": "MBR123456", 
  "groupNumber": "GRP789",
  "hasExternalEOB": false, 
  "hasMultipleEOBRemits": false, 
  "availityPayerName": "ACME Health Insurance"
}

Note: If your request returns data for more than one claim, you will receive the following message:

Search returned multiple results. Please include more search criteria to reduce result set.

Add more information in your request body to narrow your results.

5. POST/remittance-data-api/v1/checks/x12

Request:

{ 
   "checkNumber": "CHK123456",
   "checkAmount": 15420.50,
   "taxId": "123456789",
   "npi": "1234567890",
   "payerId": "PAYR001",
   "checkDateFrom": "MM/DD/YYYY",
   "checkDateTo": "MM/DD/YYYY" 
 }

Response:

{
"x12Responses": [
    {
      "checkNumber": "CHK123456", 
      "checkAmount": 15420.50,
      "taxId": "123456789",
      "npi": "1234567890", 
      "payerId": "PAYR001",
      "x12": "ISA*00*     *00*     *ZZ*123456789
*ZZ*987654321
*250315*1200*^*00501*000000001*0*P*:~GS*RA*123456789*987654321*20250315*120 
0*1*X*005010X221A1~ST*835*0001~..."
    }
  ]
}

Note: If your request returns data for more than one check/EFT, you will receive the following message:

Search returned multiple results. Please include more search criteria to reduce result set.

Add more information in your request body to narrow your results.