Additional settings

By enabling the merchant to configure more of Spice’s default settings, you can give them more possibilities when using your POS.

Port number

Spice uses port 8282 by default, but there are some cases where the merchant will want to change it to a different port; for instance, if another application is already using port 8282. Therefore, you can provide the merchant with the option to change Spice's port.

  1. In your POS's settings, provide a field for entering a port number.
  2. When the merchant enters a port number, change the Port number in Spice's settings file:
    C:\Users\%USERNAME%\AppData\Roaming\Spice\spi.json
    E.g. "Port": 1234
  3. In the POS's UI, display a confirmation message such as "Spice will now restart for the changes to take effect".
  4. Restart Spice.
  5. All requests to the Spice API must now use the new port number.
    E.g. POST http://localhost:1234/v1/purchase

Headless Mode

Certain POS setups may require the transaction pop-up UI to not appear. To setup and enable Headless mode, open the file: %APPDATA%\Spice\spi.json, which is C:\Users%USERNAME%\AppData\Roaming\Spice\spi.json. Change HeadlessTransactions to true. To disable Headless mode, change HeadlessTransactions to false.

Important: When Spice is operating in Headless mode (set as true), the posId field is required to be submitted with all transaction requests.

Note: Spice will need to be restarted for the changes to take effect.