Oracle Payment Interface
Hospitality Core Product Functionality Overview
August 2023 | Version 23.1
Copyright © 2023, Oracle and/or its affiliates
Confidential - Oracle Restricted
PURPOSE STATEMENT
This document provides an overview of features and enhancements included in the Oracle Payment Interface (OPI). It is
intended solely to help you assess the business benefits of developing integration to OPI. This document includes
descriptions of the software features, a real world user example, and confirms which functionality is optional or mandatory
to support this interface.
DISCLAIMER
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of
Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle software
license and service agreement, which has been executed and with which you agree to comply. This document and
information contained herein may not be disclosed, copied, reproduced or distributed to anyone outside Oracle without
prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any
contractual agreement with Oracle or its subsidiaries or affiliates.
This document is for informational purposes only and is intended solely to assist you in planning for the implementation
and upgrade of the product features described. It is not a commitment to deliver any material, code, or functionality, and
should not be relied upon in making purchasing decisions. The development, release, and timing of any features or
functionality described in this document remains at the sole discretion of Oracle.
Due to the nature of the product architecture, it may not be possible to safely include all features described in this document
without risking significant destabilization of the code.
1
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
TABLE OF CONTENTS
Purpose Statement
1
Disclaimer
1
Introduction
3
Hospitality Transactions
3
Oracle Hospitality – PMS Transaction Processing Messages
4
OPI Validation – Next Steps
8
2
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
INTRODUCTION
The Oracle Payment Interface (OPI) is a solution that integrates electronic payments through to the Oracle Hospitality, Food
and Beverage, and Retail Solutions.
This includes the following payment types:
•
•
•
•
•
Credit Cards e.g Visa, Mastercard, Amercian Express, Diners Club, JCB
Debit Cards
Gift Cards
Stored Value Cards
Alternative Payment Types e.g Alipay, WeChat, Swish , Twint
This interface is required to support both Card Present and Card Not Present Payments across fixed, portable and
unattended payment devices for the following transaction methods:
•
•
•
•
•
Magnetic Stripe \ Signature
EMV \ Chip and PIN
Contactless\NFC
MOTO\ Manual Entry
Gift Card\Stored Value Cards
In addition, customer also expect to see support for value added services which can also be support by OPI:
•
•
•
Dynamic Currency Conversion
Charity Donations
Credit Card Surcharge
Hospitality Transactions
To support the Oracle Payment Interface, there are some transaction types, and some fields that are mandatory in order to
support some of the Hospitality Operations. Please note the following:
•
•
3
Tokenisation: It is a mandatory feature to support tokenisation of card data for the support of OPI. Tokens are
required for any approved transaction.
Token Exchange: For Property Management Systems(PMS), it will be necessary to support the GetTokenBulk
Transaction type to support reservations sent down to PMS from 3rd parties such as Online Travel Agents, Global
Distribution Systems, Central Reservation Systems, Mobile Apps, Kiosks and Websites via the Oracle Hospitality
Intergation Platform(OHIP), OPERA Exchange Interface (OXI), OPERA Web Suite (OWS) and the OPERA HTNG
Interface
o GetToken (Bulk): This transaction type is used to exchange all PAN data stored in the PMS database at
the time OPI is installed, as well as exchanging any PAN sent through from an external 3rd party.
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
ORACLE HOSPITALITY – PMS TRANSACTION PROCESSING MESSAGES
4
TRANSACTION TYPE
OPTIONAL\
MANDATORY
DETAILS
USE CASE - EXAMPLE
Pre-Authorisation
Mandatory
Temporary hold of fund on credit
card
Guest At Check-In, the hotel will take a
preauthorisation for a set amount.
PMS allows them to set up a number
of automated rules for this. For e.g
Rate Amount * Number of Night
Stay. The automated rules are set
rather than cashiers manually
working out how much
Manual Authorisation
Optional
A manual authorization retrieves an
authorization code from a phone
call, the authorization code is then
entered in the Payment Device to
process a transaction.
Guest At Check-In, the hotel will take a
pre-authorisation for a set amount. PMS
allows them to set up a number of
automated rules for this. For e.g Rate
Amount * Number of Night Stay. The
automated rules are set rather than
cashiers manually working out how much
Top Up Authorisation
Mandatory
A top-up authorization adds an
authorized amount to the preauthorization hold.
During a guest stay, hotels will run a
credit check on guests to ensure the
preauthorised amount is enough to settle
the guest bill on check out. If the original
amount authorized is not enough, the
hotel will process an additional
authorization on the guest credit card
during their stay. This is a Card not
Present transaction.
Authorisation Release
Optional
An authorization release returns the An Electronic Pre-Authorisation Release
pre-authorized(incremental)
message is sent out at Check out for any
amount to the cardholder’s available unused authorisation amount.
credit
Sales Completion
Mandatory
The sales completion transaction
completes the pre-authorization
transaction by charging the final
amount.
Upon guest check out, the cashier will
need to settle the guest bill. The system
will get an additional authorization if
required, otherwise absorbs the previous
pre-authorisation held in the system to
process the sale completion. This could
be a Card Present or a Card not present
transaction.
Sale/Purchase
Mandatory
The sale or purchase transaction
charges the customer’s card directly
without requiring a preauthorization.
There is an option from PMS to send out
a “Sale” Transaction to accommodate
Debit Cards, and Alternative Payment
Types.
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
5
TRANSACTION TYPE
OPTIONAL\
MANDATORY
DETAILS
USE CASE - EXAMPLE
Refund
Optional
The refund transaction returns the
authorized amount back to the card
holder
After check out an account rebate is
needed for any overcharged amount and
refund to the card.
Void
Mandatory
The void transaction reverses the
original sales /purchase transaction
or sales completion. This is only
supported within the same
settlement day.
Correction of incorrect charge, must be
same amount, same business day.
Reversal
Mandatory
If the connection between PMS and
OPI terminates before OPI
completes the financial transaction,
then OPI reverses the transaction
sent to the payment partner.
Reversal for transaction when timeout
occurs
Transaction Inquiry
Optional
This is used if the transaction has
Option to request status on transaction
been lost – you can make a request
lost
to validate if the transaction was
completed on the Partner side and if
yes then a reversal is sent.
End-of-day Settlement
Optional
Batch Request for Payment
Terminals
Get Token
Mandatory
Requests the card holder data that is Saves a Token ID to PMS instead of a card
entered into the Payment Terminal
number to PMS. This could be used for
is exchanged for a token.
subsequent transactions such as preauthorisations, settlements, or sale
transactions.
Get Token (Bulk)
Mandatory
Exchange card data for tokens
This option is used to exchange any card
data in the PMS database for tokens at
the time of the OPI Installation. It is also
used to exchange card data sent through
to PMS from 3rd party reservation
systems.
Get Pan (Bulk)
Optional
Exchanges tokens for card data
Used to send the PAN back to 3rd party
reservation systems. This is a legacy
requirement in the process of being
phased out.
IsOnline
Optional
Use these elements to request an
IsOnline transaction. This message
is sent to check if the processor is
currently processing transaction at
online mode or offline mode.
Feature to check if payment service
provider is online. Only required for
Shipboard Property Management
System.
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
During the End of Day process within
PMS, a transaction request is sent out to
advise it is the end of the business date,
and allow terminals to batch. This allows
payment terminals reports to align with
the PMS business date.
6
TRANSACTION TYPE
OPTIONAL\
MANDATORY
DETAILS
USE CASE - EXAMPLE
Update Token (Bulk)
Optional
Used to replace temporary tokens
obtained during the offline periods
with real tokens.
Only required for Shipboard Property
Management System.
Gift/SVC Activate/Issue
Optional
To activate/issue a gift card or
stored value card and add value to
the card balance
Activate/Issue Gift Card or Stored Value
Card. Only supported on Shipboard PMS
or OPERA Cloud via the OPI Cloud
Service.
Gift/SVC Redeem
Optional
To process a redemption on a gift
cards or stored value cards
Process a payment on a guest account
using a Gift Card or Stored Value Card.
Only supported on Shipboard PMS or
OPERA Cloud via the OPI Cloud Service.
Gift/SVC Void
Optional
To void a payment previously
processed on a Gift Card or Stored
Value Card
To correct an incorrect payment
processed on a Gift Card or Stored Value
Card. This is supported on Shipboard
PMS only.
Gift/SVC Reload (Top
Up)
Optional
To reload or topup the value on a
gift card or stored value card
To reload or topup the value on a gift
card or stored value card. Only supported
on Shipboard PMS or OPERA Cloud via
the OPI Cloud Service.
Gift/SVC or Close Card
Optional
To close out a gift card or stored
value card
To close out a gift card or stored value
card. Only supported on Shipboard PMS
Gift/SVC Balance
Inquiry
Optional
To Check the balance on a gift card
or stored value card.
To Check the balance on a gift card or
stored value card. Only supported via
Shipboard PMS, or OPERA Cloud via OPI
Cloud Service.
Request PaybyLink URL
Optional
Request a Payment Link from a
Payment Service Provider for
customers to use to process
payments prior to arrival.
When guests create a reservation it may
require a deposit\pre-payment before
arrival. The Payment link that is
generated by the payment service
provider is added into the Confirmation
Email for the guest. The guest will then
use this link to process a payment
securely via the Payment Service
providers hosted payment page.
Request PayByLink
Payment Details
Optional
Transaction request used to request
the status of the final result on a
PaybyLink Payment processed via
the Payment Providers Hosted
Payment Page.
Once a guest has processed a Payment
via a Payment Link, the PMS will poll for
a final result of this transaction to send an
update back to PMS.
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
TRANSACTION TYPE
OPTIONAL\
MANDATORY
DETAILS
USE CASE - EXAMPLE
Pre-Authorization
eCommerce
Optional
Option for External 3rd Parties to
request a payment to be processed
via an E-Commerce Channel and
post an update back to OPERA
Cloud.
3rd parties today integrated to OPERA
often have different payment providers
compared to the hotel. This transaction
type will allow the 3rd parties integrated to
OPERA to use the Payment Service
Provider that the Hotel is using for a preauth. This is an E-Commerce transaction
type and expects Secure Customer
Authentication to be used in the countries
where that is mandated as well as support
for tokenization of card data in the
response. This transaction type is only
available via the OPI Cloud Service for the
Oracle Hospitality Integration Platform
(OHIP).
Allows 3rd Parties integrated to
OPERA Cloud to Pay for a
deposit\pre-payment prior to
arrival.
3rd parties today integrated to OPERA
often have different payment providers
compared to the hotel. This transaction
type will allow the 3rd parties integrated to
OPERA to use the Payment Service
Provider that the Hotel is using for a
sale/purchase transaction. This is an ECommerce transaction type and expects
Secure Customer Authentication to be
used in the countries where that is
mandated as well as support for
tokenization of card data in the response.
This transaction type is only available via
the OPI Cloud Service for the Oracle
Hospitality Integration Platform (OHIP).
Sale/Purchase
Optional
eCommerce Transaction
7
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
TRANSACTION FLOW DIAGRAMS
OPERA Cloud with OPI Cloud Service
Transactional flow for OPERA Cloud with OPI Cloud
Use Case 1: Reservation with Card Data via 3rd Party using Oracle Hospitality Integration Platform (OHIP) GetTokenBulk transaction type
Figure 1 –OPERA Cloud with OPI Cloud Transaction Flow Diagram - Reservation with Card Data via 3rd Party using OHIP
E1. Reservation Sent through to OHIP with Card Number
E2. Card Number is securely transmitted to the OPI Cloud Service with a request to Tokenize the card
E3. “Get Token Bulk” Request sent to Payment Service Provider to tokenize the card data
E4. Card Data is tokenized by the Payment Service Provider
E5. Token is returned to OHIP
E6. OHIP Sends updated payment details to OPERA Cloud
8
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
Use Case #2: Payment Processed with Token on file (card not present)
Figure 2 –OPERA Cloud with OPI Cloud Transaction Flow Diagram – Payment Processed using Token On file (Card not Present)
B1. Payment Request with token is initiated from OPERA Client
B2. Payment Request with token sent through to OPI Cloud
B3. Payment Request with token sent through to Payment Service Provider
B4. Payment Approved\Declined, response returned to OPI Cloud
B5. Payment Approved\Declined, response returned to OPERA Cloud
B6. Payment Approved\Declined, response returned to OPERA Client
This Transaction flow remains the same for the following use cases:
9
•
Deposit using token on file
•
Check-In using a token on file to process a pre-authorisation
•
Top Up Authorisation using a token on file
•
Check out Payment using token on file to process Sale Completion
•
Check out Payment using token on file to process Pay Only\Sale Payment
•
Deposit Cancellation - Refund using token on file
•
Void using token on file
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
Use case #3: Payment with Card presented
Figure 3 –OPERA Cloud with OPI Cloud Transaction Flow Diagram – Payment Processed
C1. Payment Request is initiated from OPERA Client
C2. Payment Request sent to OPI Cloud
C3. Payment Request sent to Payment Service Provider
C4. Payment Request sent to Payment Device
C5. Payment Device Inserts Card – send request to Payment Service Provider to Approve\Decline
C6. Response for Card sent back to Payment Device
C7. Response for Card sent back to Payment Service Provider
C8. Response for Card sent back to OPI
C9. Response for card sent back to OPERA Client
C10.Response for card stored in OPERA Database.
This Transaction flow remains the same for the following use cases:
10
•
Deposit with card presented on payment terminal
•
Check-In with card presented on payment terminal to process a pre-authorisation
•
Check out Payment with card presented on payment terminal to process Sale Completion
•
Check out Payment with card presented on payment terminal to process Pay Only\Sale Payment
•
Deposit Cancellation - Refund with card presented on payment terminal
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
•
Void with card presented on payment terminal
•
Post It with card presented on payment terminal
Transactional flow for OPERA 5 On premise with OPI
Use Case 1: Reservation with Card Data (GetTokenBulk transaction type)
Figure 4 –OPERA 5 on-premise/OPI transaction Flow Diagram
A1. Reservation Sent through to OXI with Card Number
A2. Card Number is securely transmitted to the Token Proxy Service with a request to Tokenize the card
A3. “Get Token” Request sent to Payment Service Provider to tokenize the card data
A4. Card Data is tokenized by the Payment Service Provider
A5. Token is returned to the Payment Service Provider
A6. Token is returned to the Token Proxy Service
A7. Token is returned to the OPERA Application
A8. Token is stored with the reservation in the OPERA Database
Note Payment Service Providers may have their Middleware hosted on premise at the hotel or hosted in their data centre. If
supporting Terminal Mode, this request would be routed to a Payment Terminal.
11
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
Use Case 2: Payment Processed with Token on file (Card not Present)
Note: this applies for Transaction types Pre-Auth, Sale Completion, Sale\Purchase, Void and Reversal
Figure 5 – OPERA 5 on-premise Transaction Flows with OPI for Card Not Present transactions
B1. Payment Request is initiated from OPERA Client with Token - sent through to IFC8
B2. Token with Payment Request sent through to OPI
B3. Token with Payment Request sent through to Payment Service Provider
B4. Payment Approved\Declined, response returned to OPI
B5. Payment Approved\Declined, response returned to IFC8
B6. Payment Approved\Declined, response returned to OPERA Client
B7. Payment Approved\Declined, response returned to OPI OPERA Application
12
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
Use Case 3: Payment with Card presented
Note: this applies for Transaction types Pre-Auth, Sale Completion, Sale\Purchase, Void, Refund and Reversal
Figure 6 – OPERA 5 on-premise Transaction Flows with OPI for Card Present transactions
C1. Payment Request is initiated from OPERA Client - Payment request sent to IFC8
C2. Payment Request sent to OPI
C3. Payment Request sent to Payment Service Provider
C4. Payment Request sent to Payment Device
C5. Payment Device Inserts Card – send request to Payment Service Provider to Approve\Decline
C6. Response for Card sent back to Payment Device
C7. Response for Card sent back to Payment Service Provider
C8. Response for Card sent back to OPI
C9. Response for card sent back to IFC8
C10. Response for card sent back to OPERA Client
C11. Response for Card sent back to OPERA App
C12. Response for card stored in OPERA Database.
13
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
OPI VALIDATION – NEXT STEPS
If you are comfortable with the effort required, the the next step is to review the Oracle Payment Partner Program
Agreements. Please note all the details provided here are provided under the Oracle Confidential Disclosure Agreement
Terms. It is important to review all the commercial costs and agreements before you join the Oracle Partner Network as the
OPN fees are non-refundable.

Oracle Partner Network (OPN) : As part of the partner application process you will be asked to formally join the
Oracle Partner Network (OPN). There are membership fees associated with joining the network. These are in
addition to the commercial terms of becoming a Payment Partner.
− You can begin the OPN application process here :
https://www.oracle.com/partnernetwork/program/join/

Oracle Validated Integration (OVI) Addendum: Deployment of your solution will be subject to a sign off process
by our Validation team. As part of the partnering process we will engage our Professional Services team early to
help plan your development, provision test environments for POS, PMS and OPI and to acquaint you with the
process. Once you are an OPN Member, you can apply for the validation process online.
− Enroll in Oracle Validated Integration - one enrollment form for each Oracle Product you wish to
validate from the following :
 Hospitality Solutions - Pay@Reception
 Hospitality Solutions - Pay@Cruise
 Retail Solutions – Pay@Retail
 Food and Beverage Solutions do not require an enrolment to OVI.
− Agreement Required: Oracle Applications Integration Validation Addendum to OPN Agreement

Oracle Payment Interface Amendment: Payment Partnerships are run under the auspices of the OPN but have
additional terms and conditions associated with partnership which include a Revenue Share. This is in place with all
our payment partners today. The percentage on the revenue share can not be changed, however, it is important
you review the “Net Recurring Revenue” definition in the “Fees” section of this amendment which allows you to
define which revenue you can share with Oracle. This information is not available on-line and is only offered to
those partners proceeding with the development to OPI.
OPN License and Hardware Track : Once validated, you do have additional option to join the OPN License and
Hardware Track which will provide you with additional marketing benefits
OPI Test Environment: if there is assistance required from Oracle to set up a test lab, then we can provide you with
a quote to implement a test lab. The software itself is available online once you have joined OPN.


To move forward with OPI, please reach out to the Oracle Payment Strategy Team:
fbgbu-hgbu-payments_ww@oracle.com
14
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
15
Oracle Payment Interface Product Overview | Version 22.1
Copyright © 2023, Oracle and/or its affiliates | Confidential - Oracle Restricted
CONNECT WITH US
Call +1.800.ORACLE1 or visit oracle.com.
Outside North America, find your local office at oracle.com/contact.
blogs.oracle.com
facebook.com/oracle
twitter.com/oracle
Copyright © 2023, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the contents hereof are subject to change without
notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties
and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are formed
either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without
our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of
SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group. 0120
Oracle Payment Interface_Functionality Overview_20.1
August, 2023