Documentation

Overview

In these guides, you will learn about Spice and how to integrate it with your Point of Sale (POS) machine.

Suggest Edits

The Spice integration architecture is as follows. There are two devices: the local computer (POS machine) and the EFTPOS terminal. Spice runs on the local computer along with the POS software (which has a Spice integration). Spice communicates with the POS software via the Spice API. Spice pairs with the EFTPOS terminal.

Introduction

Spice is a payment adaptor that enables your POS to make in-store payments and other transactions. It seamlessly connects your POS with an EFTPOS terminal.

It's simple to integrate Spice — just call Spice's API endpoints and let Spice handle the user interface and bank-grade transaction logic.

Here are a few reasons why our partners love Spice ...

  • Resilient — Spice can be relied upon during a network outage because it can be used while disconnected from the EFTPOS terminal.
  • Feature-rich — it supports advanced transaction types and features.
  • Easy to integrate — just follow these guides to find out how.

How to integrate Spice

The following guides will walk you through the steps to develop your Spice integration and get it certified.

  1. Getting started.
    1. Install Spice and pair it with your EFTPOS terminal.
    2. Note the requirements for your integration.
    3. Take a look at Spice's user interface.
  2. Develop an integration that handles Spice transactions as follows.
    1. Perform a ping test.
    2. Perform a purchase or refund.
    3. Handle transactions that require a signature.
    4. Recover transactions when various real-world scenarios occur.
  3. Develop any additional features for your integration such as tips and surcharges.
  4. Test your integration and get it certified by our team (or recertified).

Also, here are some resources to help you.


📘

About us

At mx51, we provide Payments as a Service (PaaS) and a range of complementary services to our partners, empowering them to connect with merchants and their customers. Learn more about us

Updated about 1 year ago