Skip to main content
  Sign in

Quick Steps

Labels

Article

Internal

Enable Settings

Still Have Questions? Submit a Request

Or Call (888) 857-9751.

Or Call (888) 276-2108.

Configuration Options in Oracle Payments Interface (OPI)

Catherine Harper
  • Updated
  1. Shift4 Payments
  2. Self Help Product Categories
  3. Partnered Solutions (3PI)
  4. Oracle MICROS
  5. Oracle Payment Interface (OPI) [Internal Only]
Description: This guide will cover all the options available within the Oracle Payment Interface (OPI) configuration.
mceclip0_-_2022-06-07T085036.038.png

The Oracle Payments Interface Configuration software (OPI) is structured with the following available options for configuration. 

 

Configuration

Merchants 

The OPI Configuration Tool contains a sub-tab referred to as "Merchants" within the Configuration tab on the navigation bar. This sub-tab is broken down into three parts: the main configuration page, the merchant information configuration page (used when either editing an existing merchant, or adding a new merchant), and the merchant configuration settings sub-tab (used when either editing an existing merchant, or adding a new merchant).
 
Below, you will find screenshots of each of the three parts, as well as a break-down behind each screenshot's settings:

Merchant | Main configuration page:

  • ID -  the merchant ID for POS merchants. For PMS merchants, the opera chain/property code.
  • Name - the name of the merchant.
  • Type -  the merchant type.

mceclip0_-_2022-06-07T085050.430.png

Merchant | Merchant Information configuration sub-tab:

POS-exclusive configuration:
  • POS Type -  the type of POS being used by the merchant.
  • Merchant Type -  the industry type that the merchant belongs to. For POS merchants, this is typically either Restaurant or Retail.
  • Merchant ID -  merchant's unique identifier.
PMS-exclusive configuration:
  • OPERA Chain -  the Opera chain code.
  • Property Code -  the Opera property code.

General configuration:

  • Name -  the merchant's name.
  • City -  the city that the merchant's location resides in.
  • State/Province -  the state/province that the merchant's location resides in.
  • Country -  the country that the merchant's location resides in.

mceclip2__45_.png

Merchant | Settings sub-tab:

POS-exclusive configuration only WITH Pay at Table service enabled:
  • RES DB Host -  the IP of the RES database.
  • RES DB Port -  the RES database's port number for communication.
  • RES DB Name - the name of the RES database.
  • RES DB User -  the username configured for the RES database.
  • Confirm RES DB User - Re-type the value above, same meaning.
  • RES DB Password - the password configured for the RES database.
  • Confirm RES DB Password - Re-type the value above, same meaning.
  • Initial DB Pool Size - the number of connections created when the database pool is initialized.
  • Max Active Connections -  the maximum number of connections allowed for the database pool.
  • Connection Wait Time - how many milliseconds the database pool will wait for a connection to be returned.
  • Min. Idle Connections -  the minimum number of idle connections allowed in the database pool.
Simphony-exclusive configuration:
  • Simphony Service URL -  the URL of the Simphony transaction service POSAPI.
  • Tenders Employee Number -  the employee number used to retrieve the tender definition from Simphony.
  • Users Employee Number - the employee number used to retrieve the employee definition from Simphony.
  • Tables Employee Number - the employee number used to retrieve the table definition from Simphony.

mceclip3__33_.png

 

Core Configuration

The OPI Configuration Tool contains a sub-tab referred to as "Core Configuration" within the Configuration tab on the navigation bar.
 
Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

Core Configuration:

  • POS Service - This toggle-able option enables/disables the POS service.
  • OPERA IFC8 Service - This toggle-able option enables/disables the Opera IFC8 service.
  • OPERA Token Service - This toggle-able option enables/disables the Opera Token Exchange service.
  • Pay at Table Service - This toggle-able option enables-disables the Pay at Table service.
  • Enforce TLS 1.2 protocol and above only - This check-box enables/disables enforcing the TLS 1.2 protocol on all communication for the POS/PMS. As a special note, OGDH & CE workstations do not support this option.
  • Log Retain Days - This value determines the number of days the OPI wrapper log files will be retained.
  • Server Time-Zone - This drop-down determines the time-zone to be used by OPI, this value should be set to match the time-zone of the machine.
  • Refresh OPI Configuration At - This configurable time-slot allows Oracle to schedule an hour/minute for OPI to re-read the configuration from its database.
  • HTTP Proxy Host - This value allows Oracle to set a proxy IP/hostname.
  • HTTP Proxy Port - This value allows Oracle to set a proxy port for communication.
  • Select Language - This drop-down allows Oracle to select what language should be used for error messages.
  • Request Encoding - This drop-down allows Oracle to configure what type of encoding should be used for request messages.
  • Enable UTG-8 encoding of response messages - This checkbox allows Oracle to enable UTG-8 encoding of response messages.

mceclip4__24_.png

 

POS Service

The OPI Configuration Tool contains a sub-tab referred to as "POS Service" within the Configuration tab on the navigation bar.

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

POS Service:

  • Mode - This drop-down allows Oracle to configure the POS service to communication via either the 'Native Driver', or 'OGDH'.
  • Port - This value allows Oracle to configure the POS service's port number being used for communication.

Native Driver-exclusive configuration:

  • Passphrase -  the passphrase for communication between the POS & OPI.
  • Confirm Passphrase - Re-type the value above, same meaning.

OGDH-exclusive configuration:

  • Certificate Passphrase -  the passphrase of the POS service's certificate.
  • Confirm Certificate Passphrase - Re-type the value above, same meaning.

mceclip5__13_.png

 

Opera Token Service

The OPI Configuration Tool contains a sub-tab referred to as "Opera Token Service" within the Configuration tab on the navigation bar.

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

Opera Token Service:

  • Mode - This drop-down allows Oracle to configure whether or not the Opera Token Service will use the HTTPS Mina mode (a newer mode introduced by Oracle to resolve performance issues), or the HTTPS legacy mode.
  • Port - This value allows Oracle to configure the Opera Token Service's port number being used for communication.

mceclip6__6_.png

 

Opera IFC8 Service

The OPI Configuration Tool contains a sub-tab referred to as "Opera IFC8 Service" within the Configuration tab on the navigation bar.

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

Opera IFC8 Service:

  • Communication Test Interval - This value allows Oracle to configure how many seconds it will take for the OPI service to test the IFC8 service's connection.
  • Enable Test Communication Heartbeat - This checkbox allows Oracle to select whether or not the OPI service will test the connection to the IFC8 service periodically.
  • Decoder Timeout - This value allows Oracle to configure how many milliseconds the OPI service will wait for the full IFC8 message to be received.
  • Bulk Tokenization Batch Size - This value allows Oracle to configure the number of items in a single tokenization request.
  • Return Receipt's Full Print Data - This checkbox allows Oracle to configure whether or not receipts will be returned with full print data to IFC8 in cross-reference fields for allowing the receipt to be printed on the folio. 

mceclip7__8_.png

 

PSP Configuration

The OPI Configuration Tool contains a sub-tab referred to as "PSP Configuration" within the Configuration tab on the navigation bar.

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:


PSP Configuration:

  • Communication Timeout - This value allows Oracle to configure how many seconds the OPI service will wait for a timeout to occur from the PSP.
  • Connect Timeout - This value allows Oracle to configure how many milliseconds the OPI service will wait before initiating a connection to the PSP.
  • Enable Mutual Authentication - This checkbox allows Oracle to enable asymmetrical encryption for PSP requests.

Mutual Authentication-exclusive configuration:

  • Private Key Certificate Password - This value should be the password set for the private key certificate.
  • Confirm Private Key Certificate Password - Re-type the value above, same meaning.
    Root Certificate Password - This value should be the password set for the root certificate password.
  • Confirm Root Certificate Password - Re-type the value above, same meaning.
  • Enable Top-Up Authorization - This checkbox allows Oracle to enable top-up authorization transactions for the Native Driver communication method.
  • Communication Mode - This drop-down allows Oracle to configure how OPI communicates for its PSP. This should always be Middleware for Shift4 integrations but allows for a WS > PED (terminal communication) mapping as well.

Terminal Communication Mode-exclusive configuration:

  • Terminal Port - This value allows Oracle to configure the port number being used for PSP devices.
  • Terminal Context - This value allows Oracleto configure if the PSP's device requires a 'context' in their connection URL.

Middleware-exclusive configuration:

  • Primary Host -  the IP/hostname of the URL OPI will communicate to for transaction requests.
  • Failover Host -  the fall over/backup IP/hostname of the URL OPI will communicate to for transaction requests.
  • Enable Inquiry Mode for Transactions Reversal - This checkbox allows Oracle to configure if OPI will verify the status of transactions before sending reversals.

mceclip8__6_.png

 

Token Exchange

The OPI Configuration Tool contains a sub-tab referred to as "Token Exchange" within the Configuration tab on the navigation bar. 

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

  • Primary Host URL - the host IP/URL for token exchange.
  • Failover Host URL -  the failover IP/host URL for token exchange.
  • Private Key Certificate Password - the password of the key store containing the root certificate for the PSP.
  • Confirm Private Key Certificate Password - Re-type the value above, same meaning.
  • Root Certificate Password -  the password of the client-side password provided by the PSP.
  • Confirm Root Certificate Password - Re-type the value above, same meaning.

mceclip9__5_.png

 

Pay at Table

The OPI Configuration Tool contains a sub-tab referred to as "Pay at Table" within the Configuration tab on the navigation bar. This sub-tab is broken down into two parts: the service settings tab, and the POS API settings tab.

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

Service Settings:

  • Mode - This drop-down allows Oracle to configure the communication method of either TCP, HTTP, or HTTPS.
  • Enable Secure Connection - This checkbox allows Oracle to configure whether or not SSL will be used for an HTTP/TCP connection.
  • TLS 1.2 Protocol and Above Only - This checkbox allows Oracle to configure whether or not the TLS 1.2+ protocols will be enforced for Pay at Table devices.
  • Port - This value allows Oracle to configure the port used for communication with the Pay at Table service.
  • Certificate Password -  the password of the Pay at Table certificate.
    Confirm Certificate Password - Re-type the value above, same meaning.
  • Device Session Lifespan - This value allows Oracle to configure how many minutes the Pay at Table device can remain idle before expiring.
  • Session Polling Interval - This value allows Oracle to configure how many minutes it takes for the device to perform a session verification.

mceclip10__2_.png

POS API Settings:

  • Mode - This dropdown allows Oracle to configure for two different POSAPI options that are allowed for OPI to use. These values are either 'Expect 100-continue, not supported', or 'Expect 100-continue, supported'. The former will send all of the message content in one message, the latter sends the message headers first, then the message content separately.
  • Communication Timeout - This value allows Oracle to configure how many seconds OPI will wait for a response from POSAPI before timing out.
  • Return Printed Check - This checkbox allows Oracle to return a printed check.

POS type of RES-exclusive configuration:

  • REST API URL -  the URL of the IP/hostname for RES POS API.
  • Tenders: AliPay - the tender object number for AliPay.
  • Tenders: Alliance -  the tender object number for Alliance.
  • Tenders: American Express -  the tender object number for AMEX.
  • Tenders: China UnionPay -  the tender object number for CUP.
  • Tenders: China UnionPay Debit -  the tender object number for CUP Debit.
  • Tenders: Debit - the tender object number for Debit.
  • Tenders: Diners Club - the tender object number for DC.
  • Tenders: Discover -  the tender object number for NS.
  • Tenders: EC Chip -  the tender object number for EC Chip.
  • Tenders: Gift Card - the tender object number for GC.
  • Tenders: GiroCard -  the tender object number for GiroCard.
  • Tenders: JCB -  the tender object number for JCB.
  • Tenders: Maestro - the tender object number for Maestro.
  • Tenders: MasterCard - the tender object number for MC.
  • Tenders: MasterCard Debit -  the tender object number for MC Debit. 
  • Tenders: Paypal -  the tender object number for Paypal.
  • Tenders: Print Check - the tender object number for Print Check.
  • Tenders: Service Charge -  the tender object number for Service Charge.
  • Tenders: Visa -  the tender object number for VS.
  • Tenders: Visa Debit - the tender object number for VS Debit.
  • Tenders: Visa Electron -  the tender object number for VS Electron.
  • Tenders: V Pay -  the tender object number for V Pay.Tenders: WeChat Pay -  the tender object number for WCP.

mceclip11__2_.png

 

Users

The OPI Configuration Tool contains a sub-tab referred to as "Users" within the Users tab on the navigation bar. 

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

Users:

To edit a user click on their profile icon. mceclip17.png

  • Username -  the user's username.
  • First Name -  the user's first name.
  • Last Name -  the user's last name.
  • Active? - This checkbox determines whether or not the user account in question is active.
  • Locked Out? - This checkbox determines whether or not the user account in question is locked out.
  • Requested Password Reset? - This checkbox is how an Administrator resets a password for a user that has requested it.

mceclip12__1_.png

New User(s):

Press the "+" icon to make a new user. mceclip15__2_.png

  • Username -  the user's username.
  • First Name -  the user's first name.
  • Last Name -  the user's last name.
  • Role - This dropdown allows Oracle to configure if the user in question is a System Administrator or a Merchant Administrator.
    • System Administrators have full access to the OPI configuration, users, and audit functions.
    • Merchant Administrators only have access to the OPI configuration.
  • One-time Password -  used to assign the user a one-time password for their first login.
  • Confirm Password - Re-type the value above, same meaning.

mceclip13__2_.png

Purge Deactivated Users

This tab performs the action of purging all users that do not contain the checkbox of "Active?" as described in the User Section.

 

Audit

Audit Trail Search

The OPI Configuration Tool contains a sub-tab referred to as "Audit Trail Search" within the Audit tab on the navigation bar. 

Below, you will find a screenshot of the configuration options, as well as a break-down behind each setting found in said screenshot:

Audit Trail Search:

  • Event Type - This dropdown allows Oracle to select which event type we'd like to view -- this ranges from All, Application (configuration related events), Security (user account-related events), and Setup (events performed by installation process).
  • Description -  for a Description if you have one to search for.
  • Username - for a Username if you have one to search for.
  • IP Address - for an IP Address if you have one to search for.
  • From Date - for a date to search in the format of yyyy-mm-dd, if you have one to search for.
  • To Date -  for a date to search to in the format of yyyy-mm-dd, if you have one to search for.

mceclip18.png

Audit Trail Purge

This tab performs the action of purging any Audit Trail events older than 90 days, it's just comprised of a button that says 'Purge'.

mceclip20__1_.png

 

Profile

User Information

This tab allows you to change your OPI User's first/last name. On the User Information page, update the values as required, and then click Save.

Change Password

This tab allows you to change your OPI User's password. select Change Password, enter the current password and then enter and confirm the New Password.

 

Sign Out

Click Sign Out to log out the configuration screen.