Adding the SPI Payment Driver
Where it can be accessed: Enterprise, Zone, Property, Revenue Center
Role Access: Payment Drivers Role
Privileges: View, Edit, Add, Delete, Override
Views: Table, form
Figure 11-1 Payment Driver Configuration: Table View Settings
Table 11-1 Table View Settings
| Field Name | Description | Data Type/Value |
|---|---|---|
| Object Number | (This cell intentionally empty.) | Integer (1–999999999 ) |
| Name | (This cell intentionally empty.) | Translatable String (128 characters) |
| Zone/Location | The hierarchy node where the record is defined. | Enterprise, Zone, Property, Revenue Center |
| Inheritance Type | Explains how this record arrived in this hierarchy node. | Inherited; Defined Here, Overriding; Defined Here, No Override |
Table 11-2 Form View Settings
| Field Name | Description | Values |
|---|---|---|
| Object Number | (This cell intentionally empty.) | Integer (1–999999999 ) |
| Name | (This cell intentionally empty.) | Translatable String (128 characters) |
| Content Type | 3 - dll, 26 - Secure DLL Configuration | List Choice (Content Type) |
| Import from a file | Browse to .dll file containing the driver’s configuration | Button |
| File Name Origin | Fully qualified name of file (must be .dll) | String |
| Configuration (OPIPayment.dll) | ||
| Description | Enter a description for the driver (for example, SPI).
|
String |
| Display Name | Enter a display name for the driver (for example, SPI).
|
String |
| Common Driver Properties | ||
| Currency Code | Enter or verify the existing ISO numeric three-digit currency code for the country. (This value can only be set when SPI Interface = True.) | Integer (3) |
| Enable Quick Chip |
Quick chip lets the guest swipe or insert a payment card at the start of a fast transaction while the workstation operator enters the menu items. Note: Before enabling Quick Chip, confirm that your PSP supports Quick Chip transactions.Set the value to True to enable Quick Chip. (available only when SPI Interface = True). |
Boolean (True, False) |
| Enable Suggested Tips |
Note: Your PSP must support this feature.Set to True to prompt the card holder with the suggested tip or dynamic tip values to on the Payment Device. (This value can only be set when SPI Interface = True.) |
Boolean (True, False) |
| Force Card Present for refund of Debit SMS (for example, Interac) transactions |
Select this option to require confirmation that the original card is present when voiding or returning transactions for Issuer ID 10 – Debit SMS. If the user selects No, the transaction does not proceed, and will not be completed. |
Boolean (True, False) |
| Merchant Number | Enter the Merchant ID. | (This cell intentionally empty.) |
| Print Copy Separator |
Enter the separator sent in PrintData. This is used to define a page cut. The default separator is @. (This value can only be set when SPI Interface = True.) |
String (1) |
| PSP Response Prefix |
Enter the prefix text that is used when displaying PSP response messages. The default prefix is PSP. (This value can only be set when SPI Interface = True.) |
String |
| Enable Line Item Display |
Set to True to enable the Line Item Display feature for this driver. Note: You must also enable the feature for each payment device in Workstation Devices, and the PSP must support this feature. |
Boolean (True, False) |
| Enable Receipt Email Prompt |
Select True to enable the payment terminal to prompt the card holder to enter the email address to which to send the receipt for this driver. Note: You must also enable the feature for each payment device in Workstation Devices, and the PSP must support this feature. |
Boolean (True, False) |
| PSP does not support TipAmount or OtherAmount in response (limits functionality) |
Select True if the PSP does not include TipAmount or OtherAmount in their response when the tip was added at the payment terminal. Selecting this option limits functionality. |
Boolean (True, False) |
| Hide Cancel option on authorization dialog |
Select to hide the Cancel button on the dialog while waiting for the card to be captured if the PSP doesn’t support this feature. |
Boolean (True, False) |
| Transport Service Properties | ||
| Host Timeout | Enter the timeout value in seconds. This is the amount of time that the host waits for a response from the PSP. The default timeout value is 180 seconds. | Integer |
| Pass Phrase | Enter the authentication Pass Phrase (OPI only). Leave this field blank for SPI. | String |
| Primary Host |
Enter the URL for the PSP endpoint. Terminal mode: If the Security Settings use HTTPS, ensure that the URL begins with |
String (url) |
| SPI Interface |
Set the value to True when using the SPI driver. This is helpful in preparation for an upgrade or switch from OPI to SPI, when you have a property with many workstations that each require a certificate. While the property is still operating on OPI and the payment driver remains set to SPI Interface = False, each SPI device can be created and certificates loaded. As long as the payment driver is not set to SPI, the device record is ignored. When the property is ready to switch to SPI, you simply need to set the SPI Interface to True. |
Boolean (True, False) |
| Validate XML Message Against Schema |
To validate the format of existing messages that are sent to the PSP against the schema, set the value to True. (This value can only be set when SPI Interface = True.) |
Boolean (True, False) |
| Security | ||
| Security Settings |
Select the appropriate option:
For one-way authentication, the PSP provides the private key for the server certificates, which must be distributed to all POS workstations. For two-way authentication, the client certificates with passwords are also issued by the PSP for each Simphony POS workstation. The Oracle Simphony Security Guide contains more information about the certificates. |
List Choice |
| Load Server Certificate | Click the ellipsis button, select the server certificate, and then click Open. | String |
| Load Client Certificate | Click the ellipsis button, select the client certificate, enter the password when prompted, and then click Open. | String |
| Delete Certificates | To delete a certificate, select Do Not Delete, Delete All Certificates, Delete Server Certificate, or Delete Client Certificate. Confirm with Yes or No. | Button |