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 CBE
Add CBE 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 > CBE
Click create new user
Copy the username and password onto a separate document and 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 CBE 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 CBE 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 CBE Account Manager asking them to configure your tills
Ask your CBE Account Manager for your site IDs
API endpoint: | |
Username: | (add the username you create here) |
Password: | (add the password you create here) |
Merchant ref: | 39 |
Product ID: | (find this on Shop > In-Store gift) |
Account ID: | (ask Toggle for this) |
The API endpoint is always https://api.mytoggle.io/graphql and the merchant ref 39 - don't change this.
Please get in touch with success@usetoggle.com to get your account ID.
Step 4: Add site IDs to Toggle
Whilst your CBE 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 > CBE
Paste in each ID to their respective site
Save
The site IDs allow the CBE 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 CBE 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 CBE so we can help troubleshoot it.
Our other guide Using Toggle on CBE POS may also be useful.
The CBE set up
Note: This part is usually done by your CBE Account Manager.
To configure a CBE till to connect to Toggle, follow these steps:
Files
The latest files for the Toggle integration are location on the CBE repository server.
File setup
1. All files from the repository will need copping to the below locations:
· C:\PixelStation\
· C:\PixelStation\DLLs\
· C:\PixelServer\
· C:\PixelServer\DLLS\
· C:\PixelStationEOI\
· C:\PixelStationEOI\DLLS\
Back office Setup
Create a Toggle Payment type with the following settings:
General Tab
Authorization Requests > Custom
Payment Options > Sale Auth (no preauth)
Advanced Tab
Custom DLL = CBEPIXELToggle.dll
Do not ask for Swipe = ticked
Allow Voids = Ticked
2. On the Advanced Tab press Setup on the custom DLL and fill in the following settings
Username and password – refer to step 2 and 3 above.
Currency – Either GBP or EUR depending on site location. If you require a different Currency Type, please contact Toggle to get one setup
AccountID – Supplied by Toggle - please ask them for this
Merchant ID - 39
ProductID – find this on Shop > In-Store gift on the Toggle dashboard
UnitPOSReference – PixelPoint Station Number
*These settings need to be set on the PixelServer Back office and the Back office on each PixelPoint Station.
3. Then create Balance Enquiry button on the Finish form with the below settings.
CBE Support
The logs for Toggle are located at C:\PixelStation\Interface\Toggle\ within your CBE domain.
Further reading
If you need further support regarding till configuration, please get in touch with your CBE account manager.