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

Suppress merchant password

When the merchant makes a refund or MOTO transaction, the EFTPOS terminal will ask them to enter their password for security against theft. However, they may prefer to enter their password into the POS instead of the terminal, so you can provide them with this option.

In your POS's settings, you can allow the merchant to select from the following options.

‘Prompt for the merchant password on the terminal’ When this option is selected ...
  1. Refund and MOTO requests must include suppressMerchantPassword: false in their request body. (Or, exclude this property from the request body, since it is false by default.)
‘Prompt for the merchant password on the POS’ When this option is selected ...
  1. Before making a refund or MOTO transaction, the POS’s UI must prompt the merchant to enter their password.
  2. The request must then include suppressMerchantPassword: true in its request body. This tells the terminal not to prompt for the merchant’s password.