Configuration variables

Your application will need to keep a configuration of variables to use for each distinct Toggle account,

These are summarised below.




For POS integrations, use 7 as the sales_channel_id when creating orders – this is a permanent ID used across all accounts for guest gratuity.


Used when creating orders, this can always be configured as either 1 (sends an Email from Toggle) or 8 which doesn't send an email.


Default to 1 (£ sterling), but leave this as something that can be configured as well, this will ensure the integration is future-proofed to handle other currency IDs in future.


account_id will be manually configured, we will provide this to you each time a new account is configured. Email to request your account_id.


This identifies you as an an approved merchant on our platform. Email to request this.


This refers to the unique site location, passed to Toggle so its knows the location where the transaction was made. This needs to be matched with the configured EPOS references in each Toggle customer's account. If your transactions don't relate to a particular site, you will need a "head office" location reference on the Toggle account to use. See here for more information.


Each order for a card should be related back to a unique transaction reference generated by your system. You should generate one (alphanumeric) and pass this to our API when handling transactions.


A discount type of 1 is a general-use FOC type so use this one if in doubt, though we also have other types available; for example 3 is for discounts for promotions.

Last updated