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

From X-Cart 4 Classic
Jump to: navigation, search
(Configuring CreSecure Hosted Payment Page Module in X-Cart)
 
(16 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}}
  
 
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.
 
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.
Line 11: Line 11:
 
If your X-Cart version is earlier than required, the module can be adapted to work with it for an additional fee.
 
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>Summary/Environment info</u> section of the X-Cart Admin area (select <u>Administration</u> -> <u>Summary</u>) on the menu.}}
+
{{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 are valid 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:'''
Line 27: Line 25:
 
: 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 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.
  
 
* If you use a UNIX-based server with terminal access:
 
* If you use a UNIX-based server with terminal access:
Line 41: Line 39:
 
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.
 
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.
+
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.
 
 
{{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> .}}
 
  
 
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 56: Line 52:
 
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.
 
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.
+
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.
  
{{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> .}}
+
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.}}
  
==Configuring CreSecure Hosted Payment Page Module in X-Cart==
+
==Configuring CreSecure Hosted Payment Page Module==
  
 
'''To configure the CreSecure Hosted Payment Page  module in your X-Cart Admin area:'''
 
'''To configure the CreSecure Hosted Payment Page  module in your X-Cart Admin area:'''
Line 74: Line 68:
 
2. Select <u>Settings</u> -> <u>Payment Methods</u> on the menu.
 
2. Select <u>Settings</u> -> <u>Payment Methods</u> on the menu.
  
3. Find <u>Payment gateways</u> drop down box at the bottom of the page, choose <u>Cre Secure Hosted Payment Page</u> from the list and click <u>Add</u> button.
+
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.
 +
 
 +
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'''.
 +
 
  
4. Note the <u>Cre Secure Hosted Payment Page</u> section appearing in the end of payment methods table. Mark the methods as active by ticking the checbox, adjust the <u>Pos.</u> value and apply changes.
+
: [[Image:payment_methods2.png]]
  
  
[[Image:payment_methods2.png|center]]
+
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.
  
  
5. Find the <u>Cre Secure Hosted Payment Page</u> section once again and click <u>Configure</u>. Submit CRE Secure Account ID and API Token provided by Cre Secure into appropriate fields.
+
: [[Image:New_config_page.jpeg|border]]
  
 +
6. Click the '''Update''' button to complete the configuration.
  
[[Image:payment_configure2.png|center]]
+
[[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.