Getting Started

This section is intended for point-of-sale (POS) software engineers looking to develop in-store EFTPOS integration using Spice Payments Adaptor. Spice is available for Windows-based POS and designed to be the simplest integration option but offers less UI flexibility compared to using the SPI library.

Spice is a Windows-based application that is installed on the POS PC and will drive transactions requested by the POS. Pairing is initiated in Spice, where the connection state is maintained and persisted. Transactions are initiated from the POS by sending HTTP requests using JSON payload to the adaptor. The Spice transaction UI will then drive the transaction workflow and return the result and receipt to the POS.

Spice can be downloaded here.


Minimum PC Requirements:

  • 1.6 GHz or faster processor (32-bit or 64-bit)
  • Windows 8 or newer
  • 2 GB Ram
  • Internet connection (will function offline)

🚧

Spice 1.5.0 Release

Spice 1.5.0 release will no longer support Windows 7. Please take this into consideration when developing or installing.

Architecture Diagram

10411041

Note: All messaging between the Point of Sale and Spice is via HTTP requests JSON payload.


API Documentation

To drive transactions the Point-Of-Sale must send HTTP requests.

The API specification for Spice is available here - Spice API doc spec

You can test sending HTTP requests to the Spice using Insomnia API through the following pre-defined commands.

Run in InsomniaRun in Insomnia

Once Insomnia is installed select "Use Localhost" from the Activate Environment dropdown. Then it's simply a matter of selecting an available GET or POST requests and clicking on "Send."


Spice Installation

  1. To install Spice, download the Spice Payments Adaptor with the link above.
  2. Open the exe file and run the installer
  3. Spice will be installed in the directory: C:\Users\ "USERNAME" \AppData\Roaming\Spice.
  4. When installation has been complete, It will ask to accept the EULA agreement
  5. Install complete, You will need to enter the correct details to pair the terminal.

Steps to integrate

  1. Obtain an mx51 test terminal through your mx51 contact.

  2. Connect your terminal to the same local network as the Spice Adaptor. Use the instructions found here.

  3. Open the Spice Payments Adaptor

  4. Open Spice and enter a valid Payment Provider, POS ID and the IP address of the EFTPOS terminal. First, select "Pair with POS" on the EFTPOS terminal and then "Pair" in Spice. Once pairing negotiation is complete click yes to confirm the code on the EFTPOS terminal. Finally, click on the OK button in Spice. The EFTPOS terminal and Adaptor are now paired.

  5. Use the API specification to implement the HTTP requests to Spice. When running the Adaptor it will listen on localhost:8282.

Getting in touch

If you would like to get in touch with a team member, please send us an email at [email protected] and we will do our best to assist you.


What’s Next

When you're ready to start development, review our checklist or recommendations.