# Changelog

Every change to the CabFare Connect APIs is listed here, newest first. See the [Versioning Policy](https://docs.cabfare.com/api/versioning) for what each type of change means for your integration.

Each entry uses these labels:

- **Added**: new endpoints, fields or values. Safe to ignore until you need them.
- **Changed**: behaviour or rules that changed without breaking existing integrations.
- **Deprecated**: still works, but will be removed in a future major version.
- **Removed**: no longer available.
- **Breaking**: requires changes to your integration.
- **Documentation**: fixes or improvements to the docs only. No API change.

## Documentation update: 28 Sep 2026

No API change.

- Documentation moved from Archbee to this site. Page addresses are unchanged, and the old endpoint pages redirect to the new API reference pages.
- Error `detail` examples now display as formatted code.
- Each endpoint group now has a short description.

## 0.5.0 update: 7 May 2026 (current)

An update to the 0.5.0 specification. The version number was not changed.

**Added**
- Payment Terminal API: optional `additionalData` on all six endpoints.
- Payment Terminal API: `isSubsidy` on `POST /payment/request`.
- Payment Terminal API: `paidAt` and `transactionId` on `POST /print/receipt`.
- Payment Terminal API: `X-API-KEY-ID` header added to the security options.

**Breaking**
- CabFare Connect API: `vehiclePlate` is now **required** on `POST /terminal/link/request`.

**Removed**
- CabFare Connect API: `GET /v1/ping` removed. Use `/v0.5.0/ping`.
- CabFare Connect API: `X-API-KEY-ID` header removed. Use `X-API-KEY` and `X-API-SECRET`.

**Documentation**
- Descriptions reformatted and personal contact details removed from the specification.

## 0.5.0: 16 Jul 2025

First published version of the CabFare Connect integration. It has three APIs:

| API | Hosted by | Endpoints |
| --- | --- | --- |
| [CabFare Connect API](https://docs.cabfare.com/api/reference/cabfare-connect) | CabFare | Taxi Meter, Payment Terminal and Testing endpoint groups |
| [Payment Terminal API](https://docs.cabfare.com/api/reference/payment-terminal) | Payment Terminal partner | 6 |
| [Taxi Meter API](https://docs.cabfare.com/api/reference/taxi-meter) | Taxi Meter partner | 4 |

---
Source: https://docs.cabfare.com/api/changelog