Skip to main content

POS Vouchers API

Introduction​

API (Application Programming Interface) is a mechanism that allows two software components to communicate with each other using a set of definitions and protocols. For example, when a Voucher enquiry is made from a POS device, the POS will communicate with the Estate Manager using requests and responses, to obtain the necessary information for transaction processing.

The communication between two software applications is facilitated by API endpoints. An API endpoint is a digital location exposed via the API from where the API receives requests and sends out responses. Each endpoint is a URL (Uniform Resource Locator) that provides the location of a resource on the API server.

Understanding the endpoints relating to specific operations will enable potential Enactor Customers to successfully integrate the Enactor solution with other third-party systems.

Below are the APIs related to Vouchers:

Overview​

POS Voucher APIs for the Voucher Serial Number Service will be discussed in this document. The purpose of this service is to provide the information on the status of tracked Voucher Serial Numbers, and to update their status, for example when issued or redeemed at a POS.

This guide will cover the configuration for the following:

  • POS Voucher APIs ' Describes each API, its usage, the sample requests and responses.

POS Voucher APIs

This section describes the details & examples of how to interact with the Enactor POS Voucher services. Each API in this section will be explained with its request, response and its respective POS function.

Voucher Serial Number Enquiry​

This service allows checking existing vouchers and retrieving the voucher details based on the serial number that is entered. This service will be requested in the POS when a voucher type is selected, and a serial number is entered to add the voucher to the basket.

![](PosVouchersAPI/voucher-serial-number-enquiry-request.png

The serial number of the added voucher is then validated from the server using this service and a response is sent back to the POS. Following is the POS screen that displays the successful response for the voucher serial number enquiry request:

For REST API - Refer Voucher Serial Number Enquiry for more details.

For SOAP API - Refer Voucher Serial Number Enquiry for more details.

Voucher Serial Number Matching Enquiry​

This service is used to check the Voucher Type for a given Voucher Number. This service will be used by the POS when the user first enters a Voucher Number before choosing a Voucher Type.

The serial number of the added voucher is then validated from the server using this service and a response is sent back to the POS. Following is the POS screen that displays the successful response for the voucher serial number matching enquiry request:

For REST API - Refer Voucher Serial Number Matching Enquiry for more details.

For SOAP API - Refer Voucher Serial Number Matching Enquiry for more details.

Voucher Serial Number Update​

This service is used to update the details of a Voucher. This service is used both when issuing and redeeming a Voucher at the POS.

Following is the POS screen that displays the requested details:

  1. When issuing a new Voucher:

  1. When redeeming a Voucher:

For REST API - Refer Voucher Serial Number Update for more details.

For SOAP API - Refer Voucher Serial Number Update for more details.

Voucher Serial Number Tracked Update​

This service is used to update the details of a Voucher that has been configured with 'Update Usage' set to true. This service will be used both when issuing a Voucher and when redeeming a Voucher in the POS that has been configured to update its usage count.

The POS functionality and screens are similar to the Voucher Serial Number Update service.

For REST API - Refer Voucher Serial Number Tracked Update for more details.

For SOAP API - Refer Voucher Serial Number Tracked Update for more details.