Requirements
For a Spice integration to be certified by our team, it must satisfy these mandatory requirements. There are also some optional features that you may choose to add.
General requirements
G1 | Spice is installed on the Point of Sale (POS) machine (not on a separate device). |
---|---|
G2 | Spice is connected to the same network as the POS. (We recommend that it is also on the same subnetwork.) |
G3 | Each request includes the 'POS-Name' and 'POS-Version' HTTP headers.
|
Transaction requirements
T1 | The following types of transactions are supported: purchases, refunds, and MOTO payments. |
---|---|
T2 |
The ‘posRefId’ of each transaction request is unique.
|
T3 | When a transaction needs to be confirmed, the Spice user interface appears above the POS user interface, allowing the merchant to click to confirm. |
T4 |
Both the merchant and customer EFTPOS receipts are either:
|
T5 | For transactions that require a signature, the ‘receipt to sign’ is printed. |
T6 |
For transactions that require a signature:
|
T7 | When a transaction is declined (e.g. due to an invalid PIN), the sale remains open. |
T8 | When a transaction cannot be made because Spice is not running, the POS displays a relevant error message. |
T9 |
When a transaction is interrupted by either:
the transaction is recovered. It is recovered automatically, or, if that is not possible, manually. |
T10 |
The POS provides ‘one-click transactions’.
|
Certification requirements
C1 | After developing a new Spice integration, all test cases are passed the certification process is completed. |
---|---|
C2 | After adding additional feature(s) to an existing Spice integration, all test cases for the additional feature(s) are passed and the recertification process is completed. |
Recommended features
These features are not required for certification but they are recommended for the benefits they provide.
Lock POS UI during a transaction
(Optional) |
When a transaction request is made, the POS’s user interface is locked against interaction until the response is returned.
(This prevents issues caused by the merchant editing the sale or leaving the page during a transaction.) |
Configurable port number
(Optional) |
Spice’s port number can be changed in the settings.
(This allows Spice to be used on a network in which port 8282 is already in use.) |
Manual override label
(Optional) |
Transactions that have been manually overridden can be identified as such during reconciliation.
(This allows these transactions to be audited for human error.) |
Reconciliation is when a merchant checks that their sales records (i.e. their merchant receipts) match their bank statements.
Additional features
Beyond these basic features, there are a variety of additional, optional features that you can include in your integration — MOTO, tips and surcharges, and more.
Updated about 1 year ago