.. /* * This file is part of the SavaPage project . * Copyright (c) 2026 Datraverse B.V. * Author: Rijk Ravestein. * * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. * SPDX-License-Identifier: CC-BY-SA-4.0 * * For more information, please contact Datraverse B.V. at this * address: info@datraverse.com */ .. _ch-webapp-admin-vouchers: Vouchers -------- .. contents:: |RST_TABLE_OF_CONTENTS| :depth: 2 :local: .. _ch-webapp-admin-vouchers-intro: Introduction ~~~~~~~~~~~~ This option is available from the pop-up menu at the footer of the :ref:`Main Menu `. Vouchers provide a straightforward and cost effective solution for users to upgrade their account balance. Vouchers are common value tokens in many applications, like for instance pre-paid mobile phones. Unlike solutions that use smart cards, micro-payments or vending machines, voucher systems require no hardware investment. While manual processing is needed to generate, print, distribute and sell the voucher cards, redemption is fully end-user driven and can be processed automatically. A voucher system is fully integrated in |PRODUCT_NAME|, and includes: - A Web App dialog for administrators to :ref:`Create Vouchers `. - A Web App dialog for end-users to :ref:`Redeem Vouchers `. - A :ref:`Voucher Security ` safety net for voucher tracking and fraud prevention. .. _ss-admin-voucher-list: .. figure:: ../images/manual/screenshots/admin/sp-01-10-voucher-list.png :alt: Admin Web App: Voucher List :width: 400px Admin Web App: Voucher List The list shows the vouchers of a selected Batch-ID and the :ref:`extra selections ` shown in the next figure. - The list is refreshed, and the selection applied, after you push the |RST_BUTTON_APPLY| button. - The |RST_BUTTON_DEFAULT| button resets the selection items to their default values. .. _ss-admin-voucher-select-and-sort: .. figure:: ../images/manual/screenshots/admin/sp-01-10-vouchers-select-and-sort.png :alt: Admin Web App: Vouchers - Select and Sort :width: 400px Admin Web App: Vouchers - Select and Sort Select vouchers by entering: - Part of their |RST_GUILABEL_NUMBER|. - Their |RST_BUTTON_VALID| or |RST_BUTTON_EXPIRED| status. - Their |RST_BUTTON_REMAINING| or |RST_BUTTON_USED| status. - Part of the |RST_GUILABEL_USER| ID that redeemed any voucher. - The |RST_GUILABEL_FROM| and |RST_GUILABEL_TO| date of their usage period. .. _ch-webapp-admin-vouchers-actions: Voucher Actions ~~~~~~~~~~~~~~~ .. note:: Due to :ref:`Admin Privileges ` this section might *not* be visible. .. _ss-admin-voucher-actions: .. figure:: ../images/manual/screenshots/admin/sp-01-10-voucher-actions.png :alt: Admin Web App: Voucher Actions :width: 400px Admin Web App: Voucher Actions - |RST_BUTTON_NEW| : pops up the dialog to :ref:`Create Vouchers `. - |RST_BUTTON_DELETE_EXPIRED| : deletes vouchers whose expiry date is before the current date (today). When a Batch-ID is selected extra buttons appear: - |RST_BUTTON_EXPIRE| : Expires all remaining vouchers of the selected Batch-ID by setting the expiry date to today 00:00. - |RST_BUTTON_DELETE| : Deletes all remaining vouchers of the selected Batch-ID. - |RST_BUTTON_VOUCHERS| : downloads a printable PDF document with remaining (non-redeemed) vouchers of the selected Batch-ID according to the selected |RST_GUILABEL_LAYOUT|. .. _ch-webapp-admin-vouchers-create: Create Vouchers ~~~~~~~~~~~~~~~ .. _ss-admin-vouchers-create: .. figure:: ../images/manual/screenshots/admin/sp-01-10-vouchers-create.png :alt: Admin Web App: Create Vouchers :width: 400px Admin Web App: Create Vouchers Enter the data for the batch as follows: - |RST_GUILABEL_BATCH_ID| : a user defined ID that will be assigned to all vouchers in a batch. The ID is prefixed to each voucher number to easily identify its source. A unique ID should be assigned to each batch. - |RST_GUILABEL_NUMBER|: the number of vouchers in the batch. - |RST_GUILABEL_VALUE| : the monetary value of each voucher. - |RST_GUILABEL_EXPIRY_DATE| : the date after which a voucher can no longer be used. This enforces that vouchers are valid for a limited period of time. - |RST_GUILABEL_LAYOUT| : the page format of the PDF output with the number of voucher columns and rows. Some fixed variants are offered. Press the |RST_BUTTON_VOUCHERS| button to create the batch. As a result: - Each voucher in the batch is assigned a formatted random unique number, for example ``B-1404-0021-0661-4775-7916``, and is stored in the database. - A printable PDF document is downloaded with all vouchers from the batch according to the selected |RST_GUILABEL_LAYOUT|. .. _ch-webapp-admin-voucher-usage: Voucher Usage ~~~~~~~~~~~~~ This is what end-users should know about vouchers. - Purchase a voucher from an authorized person at an assigned location. Vouchers are unique for your organization and cannot be used elsewhere. - Use a web browser to open the SavaPage User Web App. After logging in, your current account balance is shown at the :ref:`footer bar `. - Push the account balance button to pop-up the :ref:`User Details ` dialog, and push the :ref:`Redeem Voucher ` button in the pop-up. - Enter the voucher Number in the next dialog box and press |RST_BUTTON_REDEEM|. Make sure to enter the number exactly as listed on the voucher including any dashes (``-``). - If you entered the number correctly, the value as shown on the voucher will be transferred to your account and a new entry will list in your :ref:`transaction log `.