Configuration variables
Your application will need to keep a configuration of variables to use for each distinct Toggle account (e.g. for each of our mutual shared customers/clients).
These are summarised below.
Variable
Description
sales_channel_id
For POS integrations, use 3
as the sales_channel_id when creating orders – this is a permanent ID used across all accounts for in-store transactions.
fulfilment_method_id
If you issue digital cards from your application, and would like Toggle to send the guest the gift card - this would be 1
(Email)
If you issue digital cards from your application, and would like Toggle to send the guest the gift card - this would be 2
(Postal)
If you want to issue the card from your application, this would be 8
(3rd Party)
currency
Default to GBP
(£ 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
account_id
will be manually configured, and will be provided during onboarding of a new mutual customer. Email [email protected] to request an account_id
.
merchant_id
This identifies you as an an approved merchant on our platform. Email [email protected] to request this.
unit_epos_reference
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.
merchant_transaction_reference
This refers to the unique reference created by the your platform when the transaction is made. You will generate and pass this to our API when handling transactions.
Last updated