CPaaS Transactions API
Overview
Use the Transaction API with respect to all the POS transaction processing.
Features
The CPaaS Transactions API supports the following operations:
- Basket API: use the Basket API for transactions related to basket processing, supporting sale/return transactions. This API enables POS to do the following operations:
- POST/transactions/basket/start - initiate a new transaction.
- POST/transactions/basket/total - validate the basket content against country-specific requirements at the moment of transaction total. Once the basket is validated, it is also extended with calculated taxes. POS can then proceed with payment handling.
- POST/transactions/basket/payment - validate the basket content at the moment of payment. Once payment is validated, the basket content is extended with calculated rounding (if applied). POS can then proceed to finish the transaction.
- POST/transactions/basket/finish - finish an open transaction. It means all the necessary actions will be done by CPaaS. For example, fiscalization, printouts.
- POST/transactions/basket/abort - cancel an open transaction.
- POST/transactions/basket/item - validate basket item against country-specific requirements.
- Cash Flow API: use the Cash Flow API for transactions related to cash management operations. This API enables POS to do the following operations:
- POST/transactions/cashflow/start - start a cash flow transaction.
- POST/transactions/cashflow/finish - finish an open cash flow transaction.
- POST/transactions/cashflow/abort - abort an open cash flow transaction.
- Miscellaneous API: use the Miscellaneous API for other miscellaneous transactions, such as to store receipts. This API enables POS to do the following operations:
- POST/transactions/miscellaneous/start - start a new miscellaneous transaction.
- POST/transactions/miscellaneous/finish - finish an open miscellaneous transaction.
- POST/transactions/miscellaneous/abort - abort an open miscellaneous transaction.
- Additionally, the Health Check (GET/healthCheck) endpoint enables the API client to check the status of the dependent backend services (CPaaS Fiscal Service, CPaaS Basket Service, CPaaS Tax Service, CPaaS Mapping Service and CPaaS Restrictions Service).
NOTE: The CPaaS API only supports certain regions. For configuration details please refer to the CPaaS Documentation Suite.
Glossary
This section describes the most commonly used terms in CPaaS Transactions API.
| Term | Description |
|---|---|
| Country Package as a Service (CPaaS) | Country Package as a Service (CPaaS) is a service offering designed to structure and gather country-specific legal requirements for every supported country regarding localization, fiscalization, reporting and tax invoicing. It provides legal compliance and fiscal requirements to the Point-Of-Sale (POS) systems. |
| Lottery Code | In some countries, fiscal devices allow the registration of lottery codes for each citizen. As receipts are centralized, the Ministry of Finance organizes some prize draws to encourage people to get official fiscal receipts. |
Security
The CPaaS Transactions API supports OAuth 2.0 for authentication purposes.
The supported protocol for the CPaaS Transactions API is HTTPS.