Customer Engagement Stored Value Card Integration
Customer Engagement Stored Value Card integration allows you to process stored value cards between Order Administration and Oracle Retail Customer Engagement using point-to-point communication. Processing of stored value cards remains the same in Order Administration; however, in this integration, Order Administration uses Oracle Retail Customer Engagement APIs to send the stored value card transactions directly to the Oracle Retail Customer Engagement system for processing.
Required versions: To use the Oracle Retail Customer Engagement stored value card integration with Order Administration, you must be on version 16.0 or later of Oracle Retail Customer Engagement and Order Management System version 17.0 or later, or Order Administration.
In this topic:
-
Transactions Processed Between Order Administration and Oracle Retail Customer Engagement
-
Oracle Retail Customer Engagement Integration Setup in Order Administration
-
Stored Value Card Integration Setup in Oracle Retail Customer Engagement
-
Oracle Retail Customer Engagement APIs used in the Stored Value Card Integration
For more information: See Stored Value Card Overview and Setup for an overview of stored value card processing, and see the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for details on messages and mapping.
Transactions Processed Between Order Administration and Oracle Retail Customer Engagement
You can process the following transactions for the Oracle Retail Customer Engagement integration with Order Administration:
OACS | ORCE | See: |
---|---|---|
Activation Virtual card assignment: To assign a number to a virtual card Order Administration sends a Generate Card Request to Oracle Retail Customer Engagement. See Assigning Numbers to Virtual Stored Value Cards. Stored value card refunds: If you process a return against a stored value card pay type that has an alternate pay type or alternate refund category of stored value card defined, the system generates a new stored value card to send to the customer when you process a refund. The card is issued for the refund amount. When you process stored value card refunds, the system adds a stored value card item to the order at no charge and performs pick slip preparation. You can then follow the normal process of generating a pick slip for the stored value card item so that the card can be picked, activated, billed, and shipped to the customer. |
Generate Card (virtual card number assignment)
Recharge (virtual card activation)
Activate Instrument (physical card activation)
See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for message details. |
|
Authorization (both online and batch) |
Preauthorization
See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for message details. |
Processing Authorizations and Deposits Using Point-to-Point Communication |
Deposit Authorization amount mismatch: The deposit request might fail if the amount is different from the original authorization amount. This situation might occur if, for example, the order includes multiple stored value cards and items that were added to the order and billed in a different sequence. To correct:
|
Post Auth (Deposit)
See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for message details. |
Processing Authorizations and Deposits Using Point-to-Point Communication |
Credit Stored value card refunds: If you process a return against a stored value card pay type that does not have an alternate pay type or alternate refund category defined, the system generates a credit card credit refund against the original stored value card pay type, allowing you to reimburse the refund amount to the original stored value card instead of sending a new stored value card to the customer. |
Recharge (Reload)
See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for message details. |
Generating Stored Value Card Refunds Processing Authorizations and Deposits Using Point-to-Point Communication |
Balance Inquiry |
Inquiry
See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for message details. |
|
Authorization Reversal |
Release Auth
See the Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for message details. |
Stored Value Card Authorization Reversal |
Oracle Retail Customer Engagement integration stored value card process flow:

Oracle Retail Customer Engagement Integration Setup in Order Administration
For more information: See Stored Value Card Setup for more information on the setup required to process stored value cards in Order Administration.
Oracle Retail Customer Engagement Service Bureau Setup
Use Defining Authorization Services (WASV) to create the RLT service bureau for the Oracle Retail Customer Engagement system, taking note of these settings:
-
Service code: Must be RLT.
-
Presenter’s ID: The card prefix assigned to virtual stored value cards in Oracle Retail Customer Engagement.
Important:
When you create virtual card numbers in Oracle Retail Customer Engagement, you must create the numbers using this card prefix number. -
Submitter’s ID: The card series sequence number assigned to virtual stored value cards in Oracle Retail Customer Engagement.
Important:
When you create virtual card numbers in Oracle Retail Customer Engagement, you must create the numbers using this card series sequence number. -
Send reversal: Select this field to perform authorization reversal processing.
-
Integration layer processes: Leave these fields blank.
-
Batch/online: Select Online or Batch.
-
Immediate response: Must be selected.
-
Selected for deposit: Select this field to include the RLT service bureau in the next deposit run.
-
Primary authorization service: Must be .IL.
-
Communication type: Select Payment Link. to indicate messages sent to and from the service bureau are processed directly.
Response codes: When the Service code is RLT, the system displays the ORCE response field on the Create, Change, and Display Vendor Response screens. This field allows you to map a response from Oracle Retail Customer Engagement to a vendor response code. Use this field to enter the code assigned by the Oracle Retail Customer Engagement service bureau to identify whether the stored value card transaction was approved or declined.
Note:
The INSUFFICIENT_FUNDS response code for the RLT authorization service must be assigned a hold reason code of SV..IL Service Bureau Setup
To send transactions to the service bureau using Point-to-Point communication, create a service bureau using the service code.IL and enter a value in the following fields:
-
Application: ATDP (authorization and deposit)
-
Merchant ID: INTEGRATION LAYER
-
Charge description: Integration Layer
-
Media type: C (communications)
Enter the .IL service bureau in the Primary authorization service field for the RLT service bureau.
Web Service Authentication for Oracle Retail Customer Engagement
If the web services used to process messages to Oracle Retail Customer Engagement require web service authentication, you must provide a valid web service authentication user and password in Working with Web Service Authentication (WWSA), or client ID and client secret if using OAuth. In this situation, when Oracle Retail Order Administration generates a message to send to Oracle Retail Customer Engagement it includes the web service authentication information in the HTTP header of the message. See Oracle Retail Omnichannel Web Service Authentication Configuration Guide on My Oracle Support (2728265.1) for more information.
Work with Pay Types (WPAY)
Use Working with Pay Types (WPAY) to create a stored value card pay type to send to Oracle Retail Customer Engagement. Enter RLT as the authorization and deposit service for the stored value card pay type.
Enter 7 in the Reauthorization days for the stored value card pay type used for the Oracle Retail Customer Engagement stored value card integration.
System Control Values
-
Enter RLT in the Stored Value Card Activation Authorization Service (I26) system control value.
-
Leave the Stored Value Card Modulus Checking Method (I24) system control value blank since Oracle Retail Customer Engagement does not perform modulus checking against the digits of a stored value card number.
-
Deselect the Perform Authorization Reversal during Deposit Processing (J20) system control value since this option is not available for the Oracle Retail Customer Engagement stored value card integration.
-
Select the Perform Balance Inquiry during Batch Authorizations (J19) system control value since Oracle Retail Customer Engagement will approve an authorization for an amount that is less than the required authorization amount on the order. If you do not select this system control value, you must require another credit card payment on the order.
-
Select the Retain Unused Stored Value Card Authorization After Deposit (J21) to retain a stored value card authorization after it has been partially deposited.
-
Enter the code that identifies the Oracle Retail Customer Engagement organization that maps to your Order Administration company. The system uses this value when communicating with Oracle Retail Customer Engagement.
Stored Value Card Integration Setup in Oracle Retail Customer Engagement
For more information: See the Oracle Retail Customer Engagement Configuration Guide for more information on the setup required for gift card processing in Oracle Retail Customer Engagement.
Card Number Length
The Card Number Length property defines the number of digits used in a card number. This setting applies to all cards generated in Oracle Retail Customer Engagement, regardless of card type. Once an organization has generated card numbers, the Card Number Length setting cannot be changed. Enter a number between 10 and 16. The card number length must match the Order Administration Credit card length in Work with Pay Types (WPAY) for the stored value card pay type you send to Oracle Retail Customer Engagement.
Card Number Prefix
The Card Number Prefix property specifies the card number prefix character for a card number. Only one character can be used and is counted as part of the card length. This setting applies to all cards generated in Oracle Retail Customer Engagement, regardless of card type. The card number prefix must match the Order Administration Leading digits in Work with Pay Types (WPAY) for the stored value card pay type you send to Oracle Retail Customer Engagement.
Minimum Activation Amount and Balance
Set the minimum activation amount and balance to 0.00 indicating the amount cannot be a negative amount.
Allow Partial Redemption Setting
Set the Allow Partial Redemption setting for the tender program to No.
Pin
The PIN Required setting for a card definition indicates whether a pin if required for a stored value card.
-
On physical cards, the pin is located on the card. For virtual cards, the pin is provided in the Stored Value Card Notification Email if the program defined in the Stored Value Card Email Notification Program (I30) system control value supports it.
-
If a pin is required, you must provide the pin when using the stored value card as a form of payment. The Pin Length defines the length of the pin.
Oracle Retail Customer Engagement APIs used in the Stored Value Card Integration
The Stored Value Card Transaction Services API v3.1 is used to communicate with Oracle Retail Customer Engagement during the Customer Engagement Stored Value Card integration.
The system uses the value in the ORCE Organization Descriptor (L50) system control value along with the ORCE_CUSTOMER_SERVICE_PREFIX and ORCE_SVC_SERVICE_SUFFIX settings in Work with Customer Properties (PROP) to build the URL for communication with Oracle Retail Customer Engagement.
Note:
In order for transactions to process correctly, the Franchisee feature must be disabled in Oracle Retail Customer Engagement.Reviewing messages for the Oracle Retail Customer Engagement stored value card integration: You can review the messages passed between Order Administration and Oracle Retail Customer Engagement in the ORCE (Oracle Retail Customer Engagement) Log if its Logging Level is set to DEBUG or ALL. Use this log to help troubleshoot the Oracle Retail Customer Engagement integration.
Web service authentication? If the web services used to process inbound messages to Oracle Retail Customer Engagement require web service authentication, you must provide a valid web service authentication user and password in Working with Web Service Authentication (WWSA), or client ID and client secret if using OAuth. In this situation, when Oracle Retail Order Administration generates a message to send to Oracle Retail Customer Engagement it includes the web service authentication information in the HTTP header of the message. See Oracle Retail Omnichannel Web Service Authentication Configuration Guide on My Oracle Support (2728265.1) for more information.
Oracle Retail Customer Engagement message formats: For a complete description and message layout of the messages used to communicate with the Oracle Retail Customer Engagement system, see the Oracle Retail Customer Engagement Web Services Guide. Also, see Order Administration Web Services Guide on My Oracle Support (ID 2953017.1) for more information on mapping and messages samples.
Data security: Order Administration masks the stored value card number in the Oracle Retail Customer Engagement stored value card messages; for example, ************1111 displays instead of the full stored value card number.
Communication failure: If Order Administration is unable to connect to Oracle Retail Customer Engagement, the response message includes the reason code SU RELATE SERVICE IS UNAVAILABLE.
Error mapping: Regardless of the type of transaction processed, the information returned in the response message if a transaction is declined is the same. Order Administration maps the error code to the ORCE response field in Defining Vendor Response Codes.