Get Era Payments

Beta

GET

/api/external-consolidated-remit/v1/:consolidated_remit_id/era-payments

GET

/api/external-consolidated-remit/v1/:consolidated_remit_id/era-payments

curl https://api.joincandidhealth.com/api/external-consolidated-remit/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/era-payments \
     -H "Authorization: Bearer <token>"

{
  "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
    }
  ]
}

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

consolidated_remit_idUUIDRequired

Response

This endpoint returns an object.

consolidated_remit_idUUID

era_paymentslist of objects

Errors

403

Unauthorized Error

404

Entity Not Found Error