Difference between revisions of "X-Cart:CreSecure Hosted Payment Page"

From X-Cart 4 Classic
Jump to: navigation, search
(Overview)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
==Overview==
 
==Overview==
  
[http://www.x-cart.com/cre_secure_hosted_payment_page.html CreSecure Hosted Payment Page module] is an advanced integration of [http://www.cresecure.com/pages.php?CDpath=3_63 CreSecure Hosted Payment Page] service for an X-Cart driven store.
+
[https://www.x-cart.com/cresecure.html CreSecure Hosted Payment Page module] is an advanced integration of the [https://www.cresecure.com/pages.php?CDpath=3_63 CreSecure Hosted Payment Page] service for an X-Cart driven store. [https://www.cresecure.com/pages.php?pID=7&CDpath=0 Here is how it works].
  
 
== System requirements ==
 
== System requirements ==
  
* X-Cart 4.3.2 or above
+
{{XC version|version=4.3.2|comment=or above}}
* PHP 5.3 of above with gd lib support
 
  
To be able to successfully install and use the CreSecure Hosted Payment Page module, you must have a working copy of X-Cart Gold or X-Cart Pro already installed on your server. Make sure that the version of the CreSecure Hosted Payment Page matches the version of your copy of X-Cart.
+
To be able to successfully install and use the CreSecure Hosted Payment Page module, you must have a working copy of X-Cart Gold or X-Cart Pro installed on your server. Make sure that the version of the CreSecure Hosted Payment Page module matches the version of your copy of X-Cart.
  
{{Note1|Note: If you do not remember the version of your copy of X-Cart, you can find it in the <u>Summary/Environment info</u> section of the X-Cart Admin area (select <u>Administration</u> -> <u>Summary</u>) on the menu.}}
+
If your X-Cart version is earlier than required, the module can be adapted to work with it for an additional fee.
 +
 
 +
{{Note1|Note: If you do not remember the version of your copy of X-Cart, you can find it in the <u>Environment info</u> section of the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area.}}
  
 
==Installation and removal==
 
==Installation and removal==
 
These instructions on both installing and removing the CreSecure Hosted Payment Page  module are the same for both X-Cart Gold and X-Cart Pro.
 
  
 
'''To install the CreSecure Hosted Payment Page  module:'''
 
'''To install the CreSecure Hosted Payment Page  module:'''
  
1. Obtain a distribution package for the CreSecure Hosted Payment Page module by downloading it from the File Area section of your {{QA}} account. The distribution package is archived in the file <u>xpdf-x.y.z.tgz</u>, where <u>x</u>, <u>y</u> and <u>z</u> indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.
+
1. Obtain a distribution package for the CreSecure Hosted Payment Page module by downloading it from the File Area section of your {{QA}}. The distribution package is archived in the file <u>cre_secure_hpp-x.y.z.tgz</u>, where <u>x</u>, <u>y</u> and <u>z</u> indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.
  
 
2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
 
2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
Line 24: Line 23:
 
* If you use a Windows-based server or a UNIX-based server without terminal access:
 
* If you use a Windows-based server or a UNIX-based server without terminal access:
  
: a) Extract the contents of the archive with the CreSecure Hosted Payment Page module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).
+
: a) Extract the contents of the archive with the CreSecure Hosted Payment Page module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).
  
 
: b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.
 
: b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.
Line 34: Line 33:
 
: b) Decompress the package by typing the following command:
 
: b) Decompress the package by typing the following command:
  
<pre>tar -xzvf xpdf-x.y.z.tgz</pre>
+
<pre>tar -xzvf cre_secure_hpp-x.y.z.tgz</pre>
  
 
{{Note1|Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten! }}
 
{{Note1|Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten! }}
  
3. In a web browser, run the installation script at httр://www.example.com/install-xpdf.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.
+
3. In a web browser, run the installation script at httр://www.example.com/install-cresecure.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.
 
 
4. Enter the Auth code, accept the License Agreement and click the '''Next''' button.
 
  
{{Note|The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it in the Summary section of the X-Cart Admin area (select <u>Tools</u>-><u>Summary</u> on the administration menu), right over the License info subsection. Another way to find out the code is to retrieve the value of the $installation_auth_code variable from the file <u><xcart_dir>include/install.php</u> .}}
+
4. Enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the '''Next''' button.
  
 
5. The installation script copies the files and activates the module. Click the '''Next '''button to continue.
 
5. The installation script copies the files and activates the module. Click the '''Next '''button to continue.
Line 53: Line 50:
 
'''To uninstall the CreSecure Hosted Payment Page  module:'''
 
'''To uninstall the CreSecure Hosted Payment Page  module:'''
  
1. In a web browser, run the installation script at http://www.example.com/install-xpdf.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.
+
1. In a web browser, run the installation script at http://www.example.com/install-cresecure.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.
 
 
2. Choose the <u>Uninstall the module</u> option, enter the Auth code, accept the License Agreement and click the '''Next''' button.
 
  
{{Note1|Note: The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it in the Summary section of the X-Cart Admin area (select <u>Tools</u>-><u>Summary</u> on the administration menu), right over the License info subsection. Another way to find out the code is to retrieve the value of the $installation_auth_code variable from the file <u><xcart_dir>include/install.php</u> .}}
+
2. Choose the <u>Uninstall the module</u> option, enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the '''Next''' button.
  
3. Once the installation script has removed the CreSecure Hosted Payment Page module files and deactivated the module, click the '''Next''' button to complete the uninstallation.
+
3. Once the installation script has removed the CreSecure Hosted Payment Page module files and deactivated the module, click the '''Next''' button to complete the uninstallation.
  
 
4. On the ''Uninstallation complete'' screen, click '''Next''' to leave the Wizard.
 
4. On the ''Uninstallation complete'' screen, click '''Next''' to leave the Wizard.
  
{{Note1|Important: After you have uninstalled the CreSecure Hosted Payment Page module, make sure to remove the module's distribution package from your web directory as well.}}
+
{{Note1|Important: After you have uninstalled the CreSecure Hosted Payment Page module, make sure to remove the module's distribution package from your web directory as well.}}
  
==Enabling CreSecure Hosted Payment Page Module in X-Cart==
+
==Configuring CreSecure Hosted Payment Page Module==
  
Once you have installed the CreSecure Hosted Payment Page  module, enable it in the X-Cart Admin area. Otherwise, you will be unable to use the module for launching the affiliate system at your store.
+
'''To configure the CreSecure Hosted Payment Page  module in your X-Cart Admin area:'''
  
'''To enable the CreSecure Hosted Payment Page  module:'''
+
1. Log in to the X-Cart Admin area.
  
# Log in to the X-Cart Admin area and go to the <u>Modules</u> section (select <u>Settings</u> -> <u>Modules</u> on the administration menu).
+
2. Select <u>Settings</u> -> <u>Payment Methods</u> on the menu.
# On the list of modules, find the "CreSecure Hosted Payment Page " item and select the check box by the item's name.
 
# Scroll down to the bottom of the page and click the '''Apply changes''' button to apply the changes.
 
  
[[Image:xpdf_module_enable_page.png|center]]
+
3. Find the <u>Payment gateways</u> drop-down box at the bottom of the page, then choose <u>Cre Secure Hosted Payment Page</u> from the list and click the '''Add''' button.
  
==Configuring CreSecure Hosted Payment Page Module in X-Cart==
+
4. Note the <u>Cre Secure Hosted Payment Page</u> section that appears at the end of the payment methods table. Mark the methods as active by selecting the check box, adjust the '''Pos.''' value and then click '''Apply changes'''.
  
Now, tell your X-Cart what it should do with all the stuff you have just set up -- configure the CreSecure Hosted Payment Page  module that you installed a few steps earlier.
 
  
'''To configure the CreSecure Hosted Payment Page  module in your X-Cart Admin area:'''
+
: [[Image:payment_methods2.png]]
  
1. Log in to the X-Cart Admin area.
 
  
2. Select <u>Settings</u> -> <u>Modules</u> on the menu.
+
5. Find the <u>Cre Secure Hosted Payment Page</u> section once again and then click <u>Configure</u>. Enter you <u>CRE Secure Account ID</u> provided by Cre Secure.
  
3. Scroll down until you see the CreSecure Hosted Payment Page  module item and then click on the <u>Configure</u> link by the item.
 
  
This opens a box with options and settings for the CreSecure Hosted Payment Page  module.
+
: [[Image:New_config_page.jpeg|border]]
  
[[Image:xpdf_configuration_page.png|center]]
+
6. Click the '''Update''' button to complete the configuration.
  
4. In the CreSecure Hosted Payment Page section that appears, toggle the '''Attach PDF invoice to order notification''' and then click the '''Apply changes''' button.
+
[[Category:X-Cart modules]]
 +
[[Category:X-Cart user manual]]
 +
[[Category:X-Cart modules]]
 +
[[Category:X-Cart user manual]]
 +
[[Category:X-Cart modules]]
 +
[[Category:X-Cart user manual]]
 +
[[Category:X-Cart modules]]
 +
[[Category:X-Cart user manual]]

Latest revision as of 17:57, 22 July 2020

Overview

CreSecure Hosted Payment Page module is an advanced integration of the CreSecure Hosted Payment Page service for an X-Cart driven store. Here is how it works.

System requirements

X-Cart 4.3.2or above

To be able to successfully install and use the CreSecure Hosted Payment Page module, you must have a working copy of X-Cart Gold or X-Cart Pro installed on your server. Make sure that the version of the CreSecure Hosted Payment Page module matches the version of your copy of X-Cart.

If your X-Cart version is earlier than required, the module can be adapted to work with it for an additional fee.

Note: If you do not remember the version of your copy of X-Cart, you can find it in the Environment info section of the Summary page in X-Cart Admin area.

Installation and removal

To install the CreSecure Hosted Payment Page module:

1. Obtain a distribution package for the CreSecure Hosted Payment Page module by downloading it from the File Area section of your X-Cart Account. The distribution package is archived in the file cre_secure_hpp-x.y.z.tgz, where x, y and z indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.

2. Copy the distribution package to the X-Cart root directory on your server or hosting account.

  • If you use a Windows-based server or a UNIX-based server without terminal access:
a) Extract the contents of the archive with the CreSecure Hosted Payment Page module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).
b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.
  • If you use a UNIX-based server with terminal access:
a) Use an FTP client to upload the archive with the CreSecure Hosted Payment Page module distribution package to the X-Cart root directory on your server or hosting account.
b) Decompress the package by typing the following command:
tar -xzvf cre_secure_hpp-x.y.z.tgz
Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten!

3. In a web browser, run the installation script at httр://www.example.com/install-cresecure.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.

4. Enter the Auth code, accept the License Agreement and click the Next button.

5. The installation script copies the files and activates the module. Click the Next button to continue.

6. The installation script generates a new system fingerprint. Click the Next button to complete the installation.

7. Use the ADMINISTRATOR AREA link to log in to the Admin area.


To uninstall the CreSecure Hosted Payment Page module:

1. In a web browser, run the installation script at http://www.example.com/install-cresecure.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.

2. Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.

3. Once the installation script has removed the CreSecure Hosted Payment Page module files and deactivated the module, click the Next button to complete the uninstallation.

4. On the Uninstallation complete screen, click Next to leave the Wizard.

Important: After you have uninstalled the CreSecure Hosted Payment Page module, make sure to remove the module's distribution package from your web directory as well.

Configuring CreSecure Hosted Payment Page Module

To configure the CreSecure Hosted Payment Page module in your X-Cart Admin area:

1. Log in to the X-Cart Admin area.

2. Select Settings -> Payment Methods on the menu.

3. Find the Payment gateways drop-down box at the bottom of the page, then choose Cre Secure Hosted Payment Page from the list and click the Add button.

4. Note the Cre Secure Hosted Payment Page section that appears at the end of the payment methods table. Mark the methods as active by selecting the check box, adjust the Pos. value and then click Apply changes.


Payment methods2.png


5. Find the Cre Secure Hosted Payment Page section once again and then click Configure. Enter you CRE Secure Account ID provided by Cre Secure.


New config page.jpeg

6. Click the Update button to complete the configuration.