> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server.

# Get Era Payments

GET https://api.joincandidhealth.com/api/external-consolidated-remit/v1/{consolidated_remit_id}/era-payments

Returns metadata for every ERA payment (835 transaction set) associated with a
consolidated remit, including the source ERA document for each, and indicates which ERA
payment is currently elected as primary.

Reference: https://docs.joincandidhealth.com/api-reference/external-consolidated-remit/v-1/get-era-payments

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.joincandidhealth.com` (Production, default)
- `https://api-staging.joincandidhealth.com` (Staging)
- `https://sandbox-api.joincandidhealth.com` (CandidSandbox)
- `https://staging-api.joincandidhealth.com` (CandidStaging)
- `http://localhost:5050` (Local)

## Request

### Path parameters

- `consolidated_remit_id` (UUID, required)

## Response

### 200

- `consolidated_remit_id` (UUID, required)
- `era_payments` (list of ExternalConsolidatedRemitEraPayment, required)

## Errors

### 404 Entity Not Found Error

- `errorName` ("EntityNotFoundError", required)
- `content` (EntityNotFoundErrorMessage, required)

### 403 Unauthorized Error

- `errorName` ("UnauthorizedError", required)
- `content` (UnauthorizedErrorMessage, required)

## Types

### ExternalConsolidatedRemitEraPayment

- `era_payment` (EraPayment, required) — Includes the nested era_document with source/status/storage details.
- `is_primary` (boolean, required) — True for the ERA payment currently elected as this consolidated remit's primary remit.

### EntityNotFoundErrorMessage

- `id` (string, required)

### UnauthorizedErrorMessage

- `message` (string, optional)

### EraPayment

- `id` (UUID, required)
- `era_document` (EraDocument, required)
- `posted_at` (datetime, required) — when the edi document interchange took place
- `payer` (EraPayer, required)
- `payment_method_code` (enum, required)
  - Allowed values: `ACH`, `BKW`, `BOP`, `CAS`, `CCC`, `CCF`, `CCH`, `CDA`, `CHK`, `CLH`, `CPC`, `CWT`, `DCC`, `DCD`, `DDP`, `DEB`, `DLC`, `DLD`, `DXC`, `DXD`, `DYC`, `DYD`, `DZC`, `DZD`, `EBX`, `EXC`, `FEW`, `FWT`, `FXP`, `IWT`, `NON`, `PAC`, `PBD`, `PDC`, `PDD`, `PDE`, `PRO`, `QDR`, `QIR`, `REV`, `SCC`, `SCD`, `SDC`, `SDD`, `SWT`, `SXC`, `SXD`, `SYC`, `SZC`, `SZD`
- `check_eft_trace_number` (string, required)
- `check_issued_or_eft_effective_date` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
- `total_payment_amount_cents` (integer, required)

### EraDocument

- `id` (UUID, required)
- `source` (string, required)
- `storage_path` (string, required)
- `status` (enum, required)
  - Allowed values: `queued`, `processed`, `failed`, `manual_intervention`

### EraPayer

- `id` (UUID, required)
- `payer_name` (string, required)
- `payer_identifier` (string, optional) — Centers for Medicare and Medicaid Services PlanID. Used when reporting Health Plan ID (HPID) or Other Entity Identifier (OEID).

## Examples

**Response**

```json
{
  "consolidated_remit_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "era_payments": [
    {
      "era_payment": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "era_document": {
          "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "source": "source",
          "storage_path": "storage_path",
          "status": "queued"
        },
        "posted_at": "2024-01-15T09:30:00Z",
        "payer": {
          "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "payer_name": "payer_name",
          "payer_identifier": "payer_identifier"
        },
        "payment_method_code": "ACH",
        "check_eft_trace_number": "check_eft_trace_number",
        "check_issued_or_eft_effective_date": "check_issued_or_eft_effective_date",
        "total_payment_amount_cents": 1
      },
      "is_primary": true
    },
    {
      "era_payment": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "era_document": {
          "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "source": "source",
          "storage_path": "storage_path",
          "status": "queued"
        },
        "posted_at": "2024-01-15T09:30:00Z",
        "payer": {
          "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
          "payer_name": "payer_name",
          "payer_identifier": "payer_identifier"
        },
        "payment_method_code": "ACH",
        "check_eft_trace_number": "check_eft_trace_number",
        "check_issued_or_eft_effective_date": "check_issued_or_eft_effective_date",
        "total_payment_amount_cents": 1
      },
      "is_primary": true
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments"

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

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

print(response.json())
```

```javascript
const url = 'https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments"

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments")

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

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

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments")
  .header("Authorization", "<token>.")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```