X-Cart:X-Payments Connector - Revision history

Dohtur at 04:56, 23 January 2023

2023-01-23T04:56:59Z

Dohtur at 21:04, 31 January 2021

2021-01-31T21:04:03Z

Mouse at 09:52, 22 July 2020

2020-07-22T09:52:09Z

Dohtur: /* Connection instructions */

2019-03-15T14:04:34Z

‎Connection instructions

Dohtur at 13:43, 28 June 2018

2018-06-28T13:43:23Z

Dohtur: /* Connection instructions */

2016-09-14T18:28:50Z

‎Connection instructions

Dohtur: /* Connection instructions */

2016-09-14T18:26:09Z

‎Connection instructions

Dohtur: /* Connection instructions */

2016-09-14T16:52:59Z

‎Connection instructions

Dohtur: /* Connection instructions */

2016-09-14T16:47:52Z

‎Connection instructions

Dohtur: /* Connection instructions */

2016-09-14T16:27:43Z

‎Connection instructions

← Older revision		Revision as of 04:56, 23 January 2023
Line 4:		Line 4:

	X-Payments Connector is an add-on module for X-Cart that provides an interface for an X-Cart based online store to connect to and process payments via [https://x-payments.com X-Payments], a PCI DSS Level 1 service provider.		X-Payments Connector is an add-on module for X-Cart that provides an interface for an X-Cart based online store to connect to and process payments via [https://x-payments.com X-Payments], a PCI DSS Level 1 service provider.
		+
		+	You can find a collection of connector module packs for older X-Cart 4 versions [https://drive.google.com/drive/folders/0B6p7sehSZL8_akhxR0VwQ0dta2M?resourcekey=0-vy68iNQnNSilQx2CeNCEsQ&usp=sharing here].

	==Connecting an X-Cart store to X-Payments versions 2.1-3.x==		==Connecting an X-Cart store to X-Payments versions 2.1-3.x==

@@ Line 5: / Line 5: @@
 X-Payments Connector is an add-on module for X-Cart that provides an interface for an X-Cart based online store to connect to and process payments via [https://x-payments.com X-Payments], a PCI DSS Level 1 service provider.
-==Connecting an X-Cart store to X-Payments v2.1 or later==
+==Connecting an X-Cart store to X-Payments versions 2.1-3.x==
 ===Video tutorial===
-Below is a video tutorial on how to connect X-Payments 2.1 or later with X-Cart 4.6.4 or later. The video features the X-Payments connector modules for X-Cart 4.x Classic [https://blog.x-cart.com/x-cart-4.x-connectors-for-xpayments-updated.html released in September 2014].
+Below is a video tutorial on how to connect X-Payments 2.1-3.x with X-Cart 4.6.4 or later. The video features the X-Payments connector modules for X-Cart 4.x Classic [https://blog.x-cart.com/x-cart-4.x-connectors-for-xpayments-updated.html released in September 2014].
 <youtube>DBofEELRU-s</youtube>
@@ Line 41: / Line 41: @@
 After completing the connection of X-Payments with X-Cart via the X-Payments Connector module as provided above, you should be able to find your X-Payments payment methods in the Payment methods section of your store:<br />
 ::[[File:xc4_xp_connector_payment_methods.png|border]]<br /><br />
 ==Connecting an X-Cart store to X-Payments v1.x (User manual for old X-Cart connector modules)==

@@ Line 9: / Line 9: @@
 ===Video tutorial===
-Below is a video tutorial on how to connect X-Payments 2.1 or later with X-Cart 4.6.4 or later. The video features the X-Payments connector modules for X-Cart 4.x Classic [http://blog.x-cart.com/x-cart-4.x-connectors-for-xpayments-updated.html released in September 2014].
+Below is a video tutorial on how to connect X-Payments 2.1 or later with X-Cart 4.6.4 or later. The video features the X-Payments connector modules for X-Cart 4.x Classic [https://blog.x-cart.com/x-cart-4.x-connectors-for-xpayments-updated.html released in September 2014].
 <youtube>DBofEELRU-s</youtube>

@@ Line 14: / Line 14: @@
 ===Connection instructions===
 # Log in to the Admin back end of your X-Payments installation and make sure you have everything ready on the X-Payments end:
 ## In the Online Stores section of X-Payments ('''Settings'''->'''Online stores'''), add and configure an [https://www.x-payments.com/help/X-Payments:Managing_store_connections online store] that will represent your X-Cart store in X-Payments.<br />[[File:xp_online_store_details.png|border]]<br /><br />

@@ Line 3: / Line 3: @@
 ==  Overview ==
-X-Payments Connector is an add-on module for X-Cart that provides an interface to connect X-Cart to X-Payments, a PA-DSS v 3.x verified payment application intended for web stores accepting online credit card payments through background payment gateways. See more about X-Payments at http://www.x-cart.com/extensions/modules/xpayments.html
+X-Payments Connector is an add-on module for X-Cart that provides an interface for an X-Cart based online store to connect to and process payments via [https://x-payments.com X-Payments], a PCI DSS Level 1 service provider.
 ==Connecting an X-Cart store to X-Payments v2.1 or later==

@@ Line 37: / Line 37: @@
 ##* '''Use iframe''': Specify whether the X-Payments credit card form should be embedded in your X-Cart store's checkout via iframe (available with X-Payments 2.1.0 or newer).
 ##* '''Payment currency''': Specify the currency that should be used for all payment transactions via X-Payments.
-After completing the connection of X-Payments with X-Cart via the X-Payments Connector module as provided above, you should be able to find your X-Payments payment methods in the Payment methods section of your store:<br />[[File:xc4_xp_connector_payment_methods.png|border]]<br /><br />
+After completing the connection of X-Payments with X-Cart via the X-Payments Connector module as provided above, you should be able to find your X-Payments payment methods in the Payment methods section of your store:<br />
 ==Connecting an X-Cart store to X-Payments v1.x (User manual for old X-Cart connector modules)==

@@ Line 29: / Line 29: @@
 ## On the '''Payment methods''' tab, you can see the list of payment methods that have been imported from X-Payments - according to what payment configurations have been configured and enabled for your X-Cart store on the X-Payments end. After the deployment of the X-Payments configuration bundle in X-Cart, the imported payment methods are not yet active in your X-Cart store. To activate the methods you want to use, mark them as active by selecting the '''Active''' checkbox(es) next to their name(s). Be sure to click '''Update''' to save your changes. For payment methods that support tokenization in X-Payments, you can enable PCI compliant credit card saving in your X-Cart store by selecting the '''Use for recharges''' checkbox(es). Again, be sure to click '''Update''' to save your changes:<br />[[File:xc4_xp_connector_module_configure5.png|border]]<br /><br />Note that if you make any changes to your X-Payments payment methods on the X-Payments end, you will need to synchronize them with X-Cart. To synchronize your payment methods, use the '''Synchronize payment methods with X-Payments''' button:<br />[[File:xc4_xp_connector_sync_payment_methods.png|border]]<br /><br />As a result of synchronization, any payment methods added, updated or deleted in X-Payments will be added, updated or deleted, respectively, in X-Cart.<br /><br />
 ## If necessary, on the '''Order status mapping rules''' tab, adjust the rules for how payment statuses recognized by X-Payments should be converted to order statuses in your X-Cart store:<br />[[File:xc4_xp_connector_mapping.png|border]]<br /><br />Be sure to save your changes by clicking the '''Apply changes''' button.<br /><br />
-## If you wish to allow your X-Cart store users to save their credit card in their front-end profile, adjust the settings on the '''Save credit card setup''' tab:<br />[[File:xc4_xp_connector_save_cc_setup.png|border]]<br /><br />Be sure to save your changes by clicking the '''Apply changes''' button.<br /><br />The guidelines for adjusting the settings on the '''Save credit card setup''' tab are as follows:<br />
+## If you wish to allow your X-Cart store users to save their credit card in their front-end profile, adjust the settings on the '''Save credit card setup''' tab; be sure to save your changes by clicking the '''Apply changes''' button.<br />[[File:xc4_xp_connector_save_cc_setup.png|border]]<br /><br />Note that at least one active X-Payments payment method that supports "recharges" is required to use the save credit card feature.<br /><br />The guidelines for adjusting the settings on the '''Save credit card setup''' tab are as follows:<br />
-##* '''Enable save credit card feature''': Select this check box to enable the save credit card feature for your customers.
+##* '''Enable save credit card feature''': Select this check box to enable the save credit card feature for your customers. With this feature enabled, your customers will be able to save their card in their front-end profile.
 ##* '''Set a payment method for saving cards''': Select the payment method that you want to be used by customers who choose to save their card. ''Comment'': When a customer chooses to save their credit card with your store for future payments, you need to run an authorization against their card to have the card details saved by the payment service provider and to obtain a token that will later need to be submitted for any future authorization/charge requests for that customer to use their card for payment. The payment method selected here will be used for such authorization transactions.
 ##* '''Authorization amount''': Specify the small sum for which your store will request an authorization when saving a customer's card. ''Comment'': By default, a zero value authorization is used on the customer's card when a card is being saved. However, some payment service providers do not support zero value authorizations. If this is the case with the PSP you intend to use for card saving, adjust the authorization amount value in the "Authorization amount" field according to the requirements of your PSP so you can obtain non-zero value authorizations.<br /><br />
@@ Line 37: / Line 37: @@
 ##* '''Use iframe''': Specify whether the X-Payments credit card form should be embedded in your X-Cart store's checkout via iframe (available with X-Payments 2.1.0 or newer).
 ##* '''Payment currency''': Specify the currency that should be used for all payment transactions via X-Payments.
 ==Connecting an X-Cart store to X-Payments v1.x (User manual for old X-Cart connector modules)==

@@ Line 33: / Line 33: @@
 ##* '''Set a payment method for saving cards''': Select the payment method that you want to be used by customers who choose to save their card. ''Comment'': When a customer chooses to save their credit card with your store for future payments, you need to run an authorization against their card to have the card details saved by the payment service provider and to obtain a token that will later need to be submitted for any future authorization/charge requests for that customer to use their card for payment. The payment method selected here will be used for such authorization transactions.
 ##* '''Authorization amount''': Specify the small sum for which your store will request an authorization when saving a customer's card. ''Comment'': By default, a zero value authorization is used on the customer's card when a card is being saved. However, some payment service providers do not support zero value authorizations. If this is the case with the PSP you intend to use for card saving, adjust the authorization amount value in the "Authorization amount" field according to the requirements of your PSP so you can obtain non-zero value authorizations.<br /><br />
-## Use the '''Connection settings''' tab to provide some additional connection settings:<br />[[File:xc4_xp_connector_connection_settings.png|border]]<br /><br />Be sure to save your changes by clicking the '''Apply changes''' button.<br /><br />The guidelines for adjusting the settings on the '''Save credit card setup''' tab are as follows:<br />
+## Use the '''Connection settings''' tab to provide some additional connection settings:<br />[[File:xc4_xp_connector_connection_settings.png|border]]<br /><br />Be sure to save your changes by clicking the '''Apply changes''' button.<br /><br />The guidelines for adjusting the settings on the '''Connection settings''' tab are as follows:<br />
 ##* '''IP addresses for X-Payments callbacks (optional)''': Enter a comma-separated list of IP addresses from which your X-Payments callbacks will originate. ''Comment'': X-Payments will send callback requests to your store from specific IP addresses. To ensure that your store accepts callback requests only from these IP addresses, specify the allowed IP addresses here as a comma-separated list. Note that the address "127.0.0.1" may not be used here. For a better understanding of what IP address(es) to put here, see [https://www.x-payments.com/help/X-Payments:How_It_Works#Callback_from_X-Payments_to_the_store Callback from X-Payments to the store].
 ##* '''Use iframe''': Specify whether the X-Payments credit card form should be embedded in your X-Cart store's checkout via iframe (available with X-Payments 2.1.0 or newer).

@@ Line 27: / Line 27: @@
 # In X-Cart, paste the bundle you have copied into the appropriate field on the X-Payments Connector settings page, then click the '''Deploy''' button:<br />[[File:xc4_xp_connector_module_configure3.png|border]]<br /><br />X-Cart will take a few moments to deploy the configuration bundle. Once the deployment has been completed, a success message will be displayed at the top of the page saying that the configuration has been successfully deployed and the payment methods have been synchronized:<br />[[File:xc4_xp_connector_module_configure4.png|border]]<br /><br />
 # Now have a closer look at the X-Payments Connector settings page:<br />[[File:xc4_xp_connector_module_configure4_1.png|border]]<br /><br />Here you will need to configure your store's X-Payments-related settings.
-## On the '''Payment methods''' tab, you can see the list of payment methods that have been imported from X-Payments - according to what payment configurations have been configured and enabled for your X-Cart store on the X-Payments end. After the deployment of the X-Payments configuration bundle in X-Cart, the imported payment methods are not yet active in your X-Cart store. To activate the methods you want to use, mark them as active by selecting the '''Active''' checkbox(es) next to their name(s). Be sure to click '''Update''' to save your changes. For any methods that you want to use for tokenized payments with saved credit cards, select the '''Use for recharges''' checkbox(es). Also, be sure to click '''Update''' to save your changes:<br />[[File:xc4_xp_connector_module_configure5.png|border]]<br /><br />Note that if you make any changes to your X-Payments payment methods on the X-Payments end, you will need to synchronize them with X-Cart. To synchronize your payment methods, use the '''Synchronize payment methods with X-Payments''' button:<br />[[File:xc4_xp_connector_sync_payment_methods.png|border]]<br /><br />As a result of synchronization, any payment methods added, updated or deleted in X-Payments will be added, updated or deleted, respectively, in X-Cart.<br /><br />
+## On the '''Payment methods''' tab, you can see the list of payment methods that have been imported from X-Payments - according to what payment configurations have been configured and enabled for your X-Cart store on the X-Payments end. After the deployment of the X-Payments configuration bundle in X-Cart, the imported payment methods are not yet active in your X-Cart store. To activate the methods you want to use, mark them as active by selecting the '''Active''' checkbox(es) next to their name(s). Be sure to click '''Update''' to save your changes. For payment methods that support tokenization in X-Payments, you can enable PCI compliant credit card saving in your X-Cart store by selecting the '''Use for recharges''' checkbox(es). Again, be sure to click '''Update''' to save your changes:<br />[[File:xc4_xp_connector_module_configure5.png|border]]<br /><br />Note that if you make any changes to your X-Payments payment methods on the X-Payments end, you will need to synchronize them with X-Cart. To synchronize your payment methods, use the '''Synchronize payment methods with X-Payments''' button:<br />[[File:xc4_xp_connector_sync_payment_methods.png|border]]<br /><br />As a result of synchronization, any payment methods added, updated or deleted in X-Payments will be added, updated or deleted, respectively, in X-Cart.<br /><br />
-## If necessary, on the '''Order status mapping rules''' tab, adjust the rules for how payment statuses recognized by X-Payments should be converted to order statuses in your X-Cart store:<br />[[File:xc4_xp_connector_mapping.png|border]]<br /><br />If you make any changes to the mapping rules set by default, be sure to save them by clicking '''Apply changes'''.<br /><br />
+## If necessary, on the '''Order status mapping rules''' tab, adjust the rules for how payment statuses recognized by X-Payments should be converted to order statuses in your X-Cart store:<br />[[File:xc4_xp_connector_mapping.png|border]]<br /><br />Be sure to save your changes by clicking the '''Apply changes''' button.<br /><br />
-## On the '''Save credit card setup''' tab,
+## If you wish to allow your X-Cart store users to save their credit card in their front-end profile, adjust the settings on the '''Save credit card setup''' tab:<br />[[File:xc4_xp_connector_save_cc_setup.png|border]]<br /><br />
 ==Connecting an X-Cart store to X-Payments v1.x (User manual for old X-Cart connector modules)==