Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.1 | For an improved implementation of fiscal device management, we introduced the following new cloud-only endpoint: - PUT /devices/{deviceId}/initialize - The hardware is successfully initialized, but the POS (client) is not yet registered on the device. The following endpoints was renamed: - PUT /devices/{deviceId}/deactivate is now PUT /devices/ {deviceId}/deinitialize We introduced a new "state" property in the following endpoint : - GET /locations/{externalId}/devices/{deviceId} - . We introduced new fields, clientIds, Enabled in the POST /devices and PUT /devices/{deviceId} endpoints. Additionally, serialNumber is moved to parameters. We extended the response fields with supportedDeviceTypes array in the following endpoint. - GET/businessunits/{externalId}/parameters | v1 |
| 2025.2 | For the implementation and enhancement of fiscal device management, which ensures seamless integration of different fiscal devices into CPaaS, we introduced the following cloud-only endpoints: - POST /devices - enables the POS system to register new devices. - PUT /devices/{deviceId} - enables the POS system to update devices. - GET /devices - enables the POS system to retrieve a paged list of devices. - PUT /devices/{deviceId}/register - enables the POS system to register device with a user. - PUT /devices/{deviceId}/deregister - enables the POS system to deregister device from a user. - PUT /devices/{deviceId}/activate - marks the device as active and ready for work. - PUT /devices/{deviceId}/deactivate - marks the device as deactive and no longer ready for work. - GET /locations/{externalId}/devices/{deviceId} - enables a POS system to retrieve devices associated with a location. | v1 |
| Patch in API 2025.2 | To improve the compatibility between CPaaS and VRx, we introduced a new field gln in the response of GET /businessunits/{externalId}/parameters endpoint. gln or Global Location Number is a reference to a unique ID of the newly created Business Unit in an external system. | v1 |
| 2025.2 | To support managing region and tenant specific data we exposed the CPaaS Tenant API. To enable the POS system to define values for a particular Business Unit parameters we introduced the following endpoints: - POST /businessunits/parameters - enables the POS system to register a new business unit parameter. - DELETE /businessunits/{externalId}/parameters/{key} - enables the POS system to remove a specific business unit parameter. - GET /businessunits/{externalId}/parameters - enables the POS system to retrieve all business unit parameters associated with a specific business unit. - GET /businessunits/parameters - enables the POS system to get a paged list of business unit parameters, and to filter the business unit parameters list by providing a key-value. To support handling a particular Client Parameters we introduced the following endpoints: - POST /clients/parameters - enables the POS system to register a new client parameter. - DELETE /locations/{externalId}/clients/{clientId}/parameters/{key} - enables the POS system to delete a specific client parameter - GET /locations/{externalId}/clients/{clientId}/parameters - enables the POS system to retrieve all business unit and client parameters associated with a specific client. - GET /clients/parameters - enables the POS system to retrieve a paged list of client parameters. , - GET /healthcheck - enables service level health check. It allows the API client to check the status of the dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. | v1 |