---
title: CARE API Changelog
slug: public-apis/care-api-changelog
createdAt: 2026-05-11T20:49:58.114Z
---

::::ExpandableHeading
###

**Topic type: Concept**

:::hint{type="warning"}
**Purpose:&#x20;**&#x52;ecord contractual and behavioral changes to the CARE API over time.&#x20;

**Audience:** API integrators and client developers maintaining or upgrading integrations.&#x20;

**Applies to:&#x20;**&#x54;he CARE API and its published OpenAPI reference.&#x20;

**Does not apply to:&#x20;**&#x49;nternal implementation changes that do not affect the public API contract.
:::
::::

This changelog documents **contractual and behavioral changes** to the **CARE API**. It is intended to help integrators understand how the API has evolved and assess the impact of changes on existing integrations.

The OpenAPI reference remains the **single source of truth** for the current API contract. This changelog provides historical context and impact classification for changes reflected in the reference.

:::ExpandableHeading
## How to Read This Changelog

Each entry is listed in reverse chronological order and classified by **impact level**:

| Type                    | Meaning                                                                                                         | Client Action   |
| ----------------------- | --------------------------------------------------------------------------------------------------------------- | --------------- |
| **Breaking**            | A change that may require code changes or integration updates.<br /><br />**Classifications**: Removed, Changed | Required update |
| **Backward-compatible** | A change that does not break existing integrations.<br /><br />**Classifications**: Added, Changed, Deprecated  | Optional update |
| **Behavioral**          | Contract unchanged, behavior changed.<br /><br />**Classification**: Changed                                    | Review          |
| **Documentation**       | A clarification or correction with no contract or behavior change.<br /><br />**Classification**: Clarified     | None            |

When a field or behavior is deprecated, the changelog records:

- the deprecation date
- the recommended replacement (if applicable)
- whether removal is planned for a future release
:::

***

# Changelog Entries

:::ExpandableHeading
## Version 2.2 (Schema restructuring and new arrays)

### Type: Breaking

**Changed**&#x20;

- Removed the `careItems `section and moved the following fields to the items block:
  - `careSettlementDecision`
  - `careSettlementReason`
  - `careSettlementPrice `
  - `careSettlementUnits`

***

### Type: Backward-compatible

**Added&#x20;**

- Added new paymentMethods array
- Added new addresses array
:::

:::ExpandableHeading
## Version 2.1 (Expanded authentication options)

### Type: Backward-compatible

**Added**&#x20;

- Added support for **OAuth 2.0** (Client Credentials) authentication in addition to **Basic Authentication.**
:::

:::ExpandableHeading
## Version 2.0 (Major contract restructuring)

### Type: Breaking

**Changed**&#x20;

- Renamed `transactionID `to `originalTransactionID`
- Renamed `careType `to `careEventType`

***

### Type: Backward-compatible

**Added**

- Introduced separate specifications for Requests and Settlements
- Added new `careItems `array for recording settlement items

**Deprecated**&#x20;

- Deprecated `careTransactionType`
- Deprecated unused fields:&#x20;
  - `hashedPassword`
  - `accountStatus`
  - `pickupLocation`
:::

:::ExpandableHeading
## Version 1.3 (New item-level reason field)

### Type: Backward-compatible

**Added**

- Added `careItemReason `field to record the reason for an adjustment
:::

:::ExpandableHeading
## Version 1.2 (Authentication metadata expansion)

### Type: Backward-compatible

**Added**&#x20;

- Added `authenticationMethod `field to all events
:::

:::ExpandableHeading
## Version 1.1 (Authentication and regional routing)

### Type: Backward-compatible

**Added**&#x20;

- Introduced JWE authentication method

**Changed**&#x20;

- Updated API paths to support US and EU transaction routing
:::

