Screens
      Back to home
      1. swiftpos Help Guides
      2. Touch
      3. Screens

      3rd Party Vouchers

       


       

      Accessed by selecting the 3rd Party Vouchers option in the Loyalty System drop down list.

      Used to add a 3rd party Voucher system to integrate with swiftpos using the swiftpos Voucher API. You can view the API with the following details:

       

      Use the above screen to create a loyalty interface in swiftpos Touch.

      Now you will need to print some Barcodes that follow the following format. The test API echoes back certain details contained within the Barcode so that the API doesn't have to hold any state and works for everyone's swiftpos Vouchers:

      All Voucher Barcodes used for testing should be exactly 10 digits in length.

      1. The first 2 digits are used for masking. For example, 99.
      2. The next 3 digits determine the swiftpos Voucher to map to.
      3. The next 1 digit determines if the Voucher from/to dates should be valid (1 = Valid, 0 = Invalid).
      4. The next 1 digit determines if the Voucher has already been used or not (1 = Used, 0 = Not Used).
      5. The next 3 digits determine the 3rd party Voucher ID. For example, 001.

      Example 1 (valid, unused Voucher mapped to Voucher ID 17 in SwiftPOS): https://voucher.com/9901710001

      Example 2 (valid, already used Voucher mapped to Voucher ID 9 in SwiftPOS): https://voucher.com/9900911001

      The Company Name at the beginning would also form part of the maskingin swiftpos.

       

      Notes...



      The above details are used for testing the integration internally only. This has absolutely nothing to do with how the API will function when implemented by a 3rd party. You will need to make up some Barcodes that work with your back office database's Vouchers and print them out.

      Next setup a Barcode scanner with a card mask as per the following screenshot:

       


       

      Assuming that you've already setup some Vouchers you should now be able to start testing them. You should have printed enough different combinations of Barcodes that you can test for the various outcomes such as successful redemption, invalid from/to dates, incorrect Voucher ID, already used, etc.

       

      End of article.      ▲