CPaaS Configuration API

Overview

Use the Configuration API to provide your POS with all the necessary configuration for a particular region. Configuration Service stores configuration data for all services and POS such as Regional settings, Payment Media, Rounding, Restrictions, Taxes, Cash Payment limits, Regions.

Features

The CPaaS Configuration API provides the POS with all the necessary configuration for a particular region:

  • Retrieves a list of all regions defined in the system.
  • Retrieves a list of all approved payment medias and the rounding method used for the specified region.
  • Retrieves tax details for the specified region.
  • Retrieves a region based on the specified region code.
  • Retrieves the entire region-specific configuration.
  • Retrieves the restrictions for the specified region.
  • Retrieves details regarding cash payment limits within certain regions.
  • Retrieves the fiscal capabilities information for the specified region.
  • Retrieves the transaction types information for the specified region.
  • Retrieves a list of available reports for a specific region.
  • Retrieves a list of document configurations for a specified region.
  • Checks the status of the dependent backend services.
  • Retrieves a list of derivative document configurations.
  • Retrieves a Local Account invoice definition for the selected region.
  • Enables the POS system to issue a Local Account print form for the specified region.

NOTE: The CPaaS API only supports certain regions. For configuration details please refer to the CPaaS Documentation Suite.

Security

The CPaaS Configurations API supports OAuth 2.0 for authentication purposes.
The supported protocol for the CPaaS Configurations API is HTTPS for secure communication.