Retail:Element PS Integration
Note: this document applies to version 1.0.2 and greater published in Test Mode.
Contents |
Introduction
This document describes how to install and configure the Element PS Payment Gateway module to process debit and credit card payments in Openbravo Web POS. The implemented services are Hosted Payment and Credit Card Sale for payments and Credit Card Return and Credit Card Credit for refunds. Element PS is the company that provides the payment services this module uses.
Note: This module only applies for business based on Canada and USA.
Installation
To install the module (an Openbravo Professional instance is needed because it is a commercial module):
- Login as System Administrator
- Navigate to General Setup -> Application -> Module Management
- Click the Add Modules tab
- Find the Element PS Payment Gateway module within the list of available modules.
- Click on Install Now and follow the guided installation flow
Configuration
Element PS merchant account
Before starting processing payments using Element PS services you need first a merchant account provided by Element PS, once approved Element PS will provide the following details:
- AccountID: XXXXXXX
- AccountToken: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
- AcceptorID: XXXXXXX
These details will be required to configure the Element PS Payment Gateway in Openbravo Web POS.
Payment method configuration
Go to the window POS Terminal Type and modify the following values for the payment method you want to configure to process payments using Element PS:
- Payment Provider: Select Element PS Credit Card Credit or Element PS Hosted Payments.
- Refund Provider: Select Element PS Credit Card Return or Element PS Credit Card Credit.
After selecting in one of the previous fields one of the Element PS services the section Hosted Payments will appear with the following fields
- Account Identifier: The AccountID value provided by Element PS.
- Acceptor Identifier: The AcceptorID value provided by Element PS.
- Account Token: The AcccountToken value provided by Element PS.
- Proxy URL: The URL of the Hardware manager used as a communication proxy between the Web POS application and Element PS payment services.
- Work in production: When this checkbox is activated the transactions will be sent to the "real" Element PS server. Otherwise this payment will work in test mode.
This is a sample configuration:
permissions
In order to use the module preference to define permissions, we strongly recommend to use the following search keys for the payment methods:
- ELPS_ELPSCARD as search key of card payment method
- ELPS_ELPSHOSTED as search key of hosted payment method
Payment Services
Element PS Credit Card Credit
Process a payment using a credit card read by a driverless PINpad (Ingenico iPP320) reader.
Element PS Hosted Payments
In this service, Element PS provides the web interface and functionality to process payments. Payments can be processed using a driverless PINpad (Ingenico iPP320) reader or typed in the form.
Refund Services
Element POS Credit Card Return
Process returns based on a previous payment. It requires the Transaction ID value of the payment to return. The amount to return cannot be greater of the paid amount.
Element POS Credit Card Credit
Performs an straight credit or blind credit to the credit card read by a driverless PINpad (Ingenico iPP320) reader.
Operation
Once payment method has been properly configured you can start processing payments in Openbravo Web POS. To do this just add a new payment using the payment method configured to be processed by Element PS Payment Gateway. Once selected a window will appear requesting the card details.
Using hosted payments:
Hosted payments allow us to introduce the credit card details using a compatible magnetic card reader or can keying the credit card information.
This is an example of the payment modal using element PS hosted payments:
1. Complete the fields
2. Success information
3. Payment receipt
4. Created receipt for the Order
Using credit card sale to do a sale:
Hosted payments allow us to introduce the credit card details using a compatible magnetic card reader or can keying the credit card information.
This is an example of the payment modal using element PS hosted payments:
1. swype the card
2. Payment receipt
3. Created receipt for the Order
Removing payments
Payments can be removed using the x button. When this button is pressed a transaction to void the payment is sent to element PS servers. A receipt is also printed.
1. swype the card
2. Payment receipt
