---
title: Retail API Changelog
slug: legacy-fraud-apis/retail-api-changelog
createdAt: 2026-05-12T11:59:05.777Z
---

::::ExpandableHeading
###

**Topic type: Concept**

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

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

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

**Does not apply to:&#x20;**&#x55;niversal APIs, any other industry, or internal implementation changes that do not affect the public API contract.
:::
::::

This changelog documents **contractual and behavioral changes** to the **Retail 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.6 (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.5 (Payment schema field relocation)

### Type: Breaking

**Changed**&#x20;

- Moved `isPaymentRecurring` from the `paymentMethods` block to the payment block
:::

:::ExpandableHeading
## Version 2.4 (Authentication and payment enhancements)

### Type: Breaking

**Removed**&#x20;

- Removed support for:&#x20;
  - JWT Authentication
  - Custom Authentication

***

### Type: Backward-compatible

**Added**&#x20;

- Added `secCard` as a payment type for corporate-issued payments used within secure payment portals
- Added `isRecurring` field to the `paymentMethods` object for subscription handling

**Changed**&#x20;

- Moved `accountStatus` and `hashedPassword` to the root level
:::

:::ExpandableHeading
## Version 2.3 (Authentication and token support)

### Type: Backward-compatible

**Added&#x20;**

- Added `authenticationMethod` field
- Added `cardToken` field to the `paymentMethods` block
:::

:::ExpandableHeading
## Version 2.2 (Guest checkout and documentation updates)

### Type: Backward-compatible

**Added&#x20;**

- Added `isGuestCheckout` field

***

### Type: Documentation&#x20;

**Clarified**

- Updated payload example
:::

:::ExpandableHeading
## Version 2.1 (Authentication and regional support)

### Type: Backward-compatible

**Added**

- Introduced JWE authentication method
- Added notes for SCA optimization

**Changed&#x20;**

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

