Note: Only Store Owner users can create the API on Step 2.

Summary

Add your site(s) to Toggle
Create an API on Toggle
Send the API details to Datasym (DBE)
Add Datasym (DBE) site IDs to Toggle
Test if a gift voucher works at your site(s)

Step 1: Add your site(s) on Toggle

If needed here's more info on how to add sites (video included).

The sites you'll be redeeming gift cards at need adding to Toggle. This step might already be done, but it's worth checking.

Log in to Toggle
On the sidebar click Settings > Site Settings
Add the site name, its address, and any number or reference for it
Click add
Repeat this step for however many sites you need to add

Step 2: Create an API on Toggle

If needed here's more info on how to create the API (video included).

Log in to Toggle
On the sidebar click Settings > Integrations > Datasym (or DBE)
Click create new user
Copy the username and password onto a separate document then press create

Once you click create you can't retrieve the API password again so that's why we recommend saving it in a separate document.

Step 3: Send the API to Datasym (DBE) and ask for your site IDs

You'll need to send the API username and password you created on Step 2 along with the info below to your Datasym (DBE) Account Manager.

Copy the table below into something like a Word document
Add the API username and password to it
Password protect the file for security
Send the file to your Datasym (DBE) Account Manager asking them to configure your tills
Ask your Datasym (DBE) Account Manager for your site IDs

API endpoint:	https://api.mytoggle.io/graphql
Username:	(add the username you create here)
Password:	(add the password you create here)
Merchant ref:	10
Standard in-store product ID:	(find this on Shop > In-Store gift)
Account ID:	(find this on Account Details)

Step 4: Add site IDs to Toggle

Whilst your Datasym (DBE) Account Manager does the relevant configuration using your API details, add the site IDs they sent you to Toggle.

Log in to Toggle
On the sidebar click Settings > Integrations > Datasym (or DBE)
Paste in each ID to their respective site
Save

The site IDs allow the Datasym (DBE) and Toggle system to know where a gift card was sold or redeemed at. Without these IDs in Toggle your integration won't work.

Step 5: Test the integration works

Once your Datasym (DBE) Account Manager has confirmed they've configured your tills it's good to check vouchers do work.

We recommend you:

Send yourself a free of charge digital voucher
Use the voucher code on the till to see if it works (e.g. redeem it, check balance)

Other people on your team may benefit from seeing how gift vouchers works durng this stage.

If an error is flagged on the till, get in touch with Toggle and Datasym (DBE) so we can help troubleshoot it.

Our other guide Using Toggle on DBE POS may also be useful.

The Datasym (DBE) set up

To get started, ask your DBE Account Manager to configure Toggle on your installation of DBE (Datasym) POS. They will enable Toggle Gift Cards on your POS system. Once the configuration is complete, Toggle Gift Cards will be available as a payment method on your POS.

If you are managing the configuration of your POS installation, follow the steps below.

DPOS SQL Setup (Self managed configuration only)

Please note: The below instructions only apply if you are configuring your own POS system. Otherwise, get in touch with your POS support who will handle this setup for you.

Toggle Gift cards are enabled by selecting Toggle from the dropdown list on the Gift Cards page of the DPOS SQL config editor:

This will display all the config fields below that need information entered to complete the setup. Refer to Step 2 and 3 of the DBE: Connecting your tills with Toggle guide to get these details.

API Endpoint: https://api.mytoggle.io/graphql
Username
Password
AccountID
ProductID

The currency will be GBP.

The POS Reference needs to be the same one that you enter when you configure your sites in Toggle. So you can make one up, as long as you use a unique reference for each of your sites, if you have more than one.

DPOS SQL Database (Self managed configuration only)

You will need to ensure the Gift Card MOP (Method of Payment) is enabled in the MOPS table of the DPOSQL database. If you want the values taken on gift cards included in the z-read you will also need to set the IncludeInDrawCount column to ‘True’.

Stockade (Self managed configuration only)

To set up a button to sell a gift card you will need to add a new button to the till via the schema editor (Maintenance > POS Buttons).

The button type is ‘Gift Card’ and in the data field you can enter the value. e.g. 10 = £10. This allows you to sell preset gift card values (e.g. £10 Gift Card). However, if you want to allow open priced gift card, then leave the data field blank.

If you need help or have questions please contact our support team at success@usetoggle.com.