Created : 15 April 2015
Last Modified : 09 Sept 2022
***********************************************************************************
Contents:

A. SUMMARY
B. FILE STRUCTURE
C. INSTALLATION INSTRUCTION
D. CHANGES
E. CONFIGURATION SETTINGS
F. DATABASE TABLES MODIFIED
G. LANGUAGE SETTINGS CHANGED
H. CHANGE LOGS
I. TROUBLESHOOTING
J. FAQ
K. COPYRIGHT NOTICE
L. TERMS AND CONDITIONS
***********************************************************************************

A. SUMMARY
==========

This interface is for use with Global Payments (previously RealEx) Gateway

***********************************************************************************

B. FILE STRUCTURE
===================

Files included in the zip are:
- $readme_realex.txt
- realex_execute.asp
- realexconfig.asp
- realexgateway.asp
- realexresult.asp
- realexsha1.asp
- realcountryISO.asp
- admin\realex_setup.asp
- admin\realex_setup_config.asp
- admin\realex_setup_process.asp
- admin\sqlscripts\realex\*

***********************************************************************************

C. INSTALLATION INSTRUCTION
============================

1. Upload all the files into your shopping cart folder.

2. Log into super admin and execute setup file, eg: http://www.yourdomain.com/yourshoppingcartfolder/youradminfolder/realex_setup.asp

3. After setup the module, would be redirected Module configuration page for configure the module

Enable? : Please set to Yes to activate this Global payments module.

Merchant ID : Please enter your Merchant ID. Login to your Global payments account at https://www.realexpayments.com/ (sign up if you don’t already have an account) and grab your Merchant ID.

Shared Secret : Please enter your Shared Secret. Login to your Global payments account at https://www.realexpayments.com/ and grab your Shared Secret.

Currency : Enter the currency code that is used for your store.

Gateway Location : Default live URL is https://pay.sandbox.realexpayments.com/pay
For testing (sandbox) the gateway URL is https://pay.sandbox.realexpayments.com/pay

For testing purpose, you can go to https://developer.realexpayments.com and click "Request a Test Account" at the top right.

Global payments test Visa Number:
-----------------
Number - Response Code - Response Message
4263971921001307 - 00 - Successful
4000126842489127 - 101 - DECLINED
4000136842489878 - 102 - REFERRAL B
4000166842489115 - 103 - REFERRAL A
4009837983422344 - 205 - Comms Error

Trace Mode : Set to Yes only if you have issue with your Global payments and you want to see the response values returned from Global payments to the VPCart site after a payment is submitted.

Click Save button if all the above fields are filled in.

4. You must tell Global payments where the return page (realexresult.asp file) is located on your VPCart site.
* Example
http://www.yoursite.com/shopping/realexresult.asp

Or if your site has SSL certificate installed, the return url should be in https mode eg :
https://www.yoursite.com/shopping/realexresult.asp

Global payments will NOT work unless this is set-up properly. You must coordinate this with Global payments Technical staff to setup this return url for your account.

Troubleshooting
---------------
Why the transaction fail?

- Response Code return an "Error" Message.

Please check your Gateway Location, Merchant ID and Shared Secret.
If you are sure the information is correct, please wait for 5 minutes and then submit again.
(That might be some network temporaly break down between your server and payment gateway)

- The checkout can redirect to Global payments site, but returns error :

Error 508
Incorrect hash

Please make sure that you enter correct Merchant ID and Shared Secret values that you received from Global payments into the Modules Manager for Global payments as these are used to generate your hash key.
If this still doesn't work, please contact Global payments for the correct Merchant ID and Shared Secret.


***********************************************************************************

D. CHANGES
===============

NONE

***********************************************************************************

E. CONFIGURATION SETTINGS
=================

NONE


F. DATABASE TABLES MODIFIED
===========================

NONE

***********************************************************************************

G. LANGUAGE SETTINGS CHANGED
============================

NONE

***********************************************************************************

H. CHANGE LOGS
============================

2015.10.27 - Update successmessage routine in file realexresult.asp rather than reading :
To continue browsing please click here
It is now reading : To complete this order and get this order email you MUST click here.
This is to make sure customers will get order email after successful payment.
2017.11.11 - Readme update.
2017.12.21 - Readme update for the gateway company name to Global payments.
2018.04.18 - Compatible with v9
2019.04.06 - Updated to be compatible for Strong Customer Authentication (SCA) and 3D Secure 2 (3DS v2)
2019.05.11 - Updated Gateway Endpoint URL
2020.11.27 - Fix for error 508: Invalid length for HPP_BILLING_STREET2 and HPP_SHIPPING_STREET2
2020.11.28 - Fix length for HPP_BILLING_CITY, HPP_SHIPPING_CITY, HPP_BILLING_STREET1, HPP_SHIPPING_STREET1, and HPP_CUSTOMER_PHONENUMBER_MOBILE format
2022.09.09 - Added parameters HPP_VERSION and HPP_CHANNEL for 3DS v2

***********************************************************************************

I. TROUBLESHOOTING
============================

Please submit a ticket to our helpdesk at https://helpdesk.vpcart.com and our support team will assist you.

***********************************************************************************

J. FAQ
============================

NONE

***********************************************************************************
K. COPYRIGHT NOTICE
============================

Copyright (c) 1999-2019 Rocksalt International Pty. Ltd.
All rights reserved.

This software and documentation constitute a published work and
contains valuable trade secrets and proprietary information
belonging to Rocksalt International Pty. Ltd. .
None of the foregoing material may be copied,
duplicated or disclosed without the express written permission
of Rocksalt International Pty. Ltd. .

LICENSEE ACCEPTS VP-ASP Shopping Cart "AS IS" "WITH ALL FAULTS",
Rocksalt International Pty. Ltd. accepts no responsibility for the
operation or performance of the VP-ASP Shopping Cart.
The entire risk of use and consequences of use of the
VP-ASP Shopping Cart falls completely on the Licensee
and Rocksalt International Pty. Ltd. shall not be liable in any respect
for any claims, loss or injury alleged to have resulted
from use of or in reliance on VP-ASP Shopping Cart.

Licensee acknowledges that it has read the foregoing
disclaimers of warranty and limitation of liability
and understands that Licensee assumes
the entire risk of using VP-ASP Shopping Cart.


***********************************************************************************

L. TERMS AND CONDITIONS
============================
ROCKSALT INTERNATIONAL GRANTS TO THE LICENSEE A NON-EXCLUSIVE,
NON-SUB LICENSABLE, NONTRANSFERABLE LICENSE
TO INSTALL AND USE THIS APPLICATION ON A SINGLE DOMAIN FOR
A SINGLE SHOP.

THE CODE IN THE APPLICATION MAY BE MODIFIED FOR USE IN
SETTING UP A SINGLE SHOPPING SITE ON THE WORLD WIDE WEB.

LICENSEE MAY MAKE A COPY OF THE APPLICATION FOR
BACK-UP AND ARCHIVAL PURPOSES, PROVIDED THAT ANY COPY
MUST CONTAIN ALL PROPRIETARY NOTICES INCLUDED
WITH THE APPLICATION.

LICENSEE IS PROHIBITED FROM SELLING OR DISTRIBUTING
THE APPLICATION IN ANY MANNER.

LIMITATION OF LIABILITY.

ROCKSALT INTERNATIONAL AND ITS LICENSORS SHALL
NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY
THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING THIS
APPLICATION.

IN NO EVENT WILL ROCKSALT INTERNATIONAL OR ITS LICENSORS
BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA,
OR FOR DIRECT, INDIRECT, SPECIAL,
CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES,
HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LI
ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE,
EVEN IF ROCKSALT INTERNATIONAL HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.