CARE API Changelog
5 min
\<font color="#b6c7cb">\</font> topic type concept purpose record contractual and behavioral changes to the api over time audience api integrators and client developers maintaining or upgrading integrations applies to the api and its published openapi reference does not apply to internal implementation changes that do not affect the public api contract this changelog documents contractual and behavioral changes to the 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 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 classifications removed, changed required update backward compatible a change that does not break existing integrations classifications added, changed, deprecated optional update behavioral contract unchanged, behavior changed classification changed review documentation a clarification or correction with no contract or behavior change 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 version 2 2 ( schema restructuring and new arrays) type breaking changed removed the careitems section and moved the following fields to the items block caresettlementdecision caresettlementreason caresettlementprice caresettlementunits type backward compatible added added new paymentmethods array added new addresses array version 2 1 ( expanded authentication options) type backward compatible added added support for oauth 2 0 (client credentials) authentication in addition to basic authentication version 2 0 ( major contract restructuring) type breaking changed 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 deprecated caretransactiontype deprecated unused fields hashedpassword accountstatus pickuplocation version 1 3 ( new item level reason field) type backward compatible added added careitemreason field to record the reason for an adjustment version 1 2 ( authentication metadata expansion) type backward compatible added added authenticationmethod field to all events version 1 1 ( authentication and regional routing) type backward compatible added introduced jwe authentication method changed updated api paths to support us and eu transaction routing