X-Cart:X-Payments Connector

From X-Cart 4 Classic
Revision as of 14:18, 14 November 2012 by Seyfin (talk | contribs) (Adding X-Payments payment methods)
Jump to: navigation, search
X-Cart 4.4.0


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 1.2 verified payment application intended for web stores accepting online credit card payments through background payment gateways. X-Payments Connector ensures correct implementation of the following tasks:

  • Importing the data on active payment methods from X-Payments to X-Cart;
  • Transferring cart and customer details from X-Cart to X-Payments;
  • Redirecting the customer from X-Cart to X-Payments and back to X-Cart;
  • Synchronizing transaction and order details between X-Payments and X-Cart.

Video tutorial

System requirements

To successfully install and use the X-Payments Connector add-on module, you must have:

  • Installed copy of X-Cart v4.3.0 or later;
  • Installed copy of X-Payments v 1.0 or later;
  • PHP extensions:
  • libCurl version >= 7.10;
  • OpenSSL extension;
  • XML DOM extension (to parse XML data).
Note: X-Cart 4.4.x and 4.5.x versions already have the X-Payments Connector included into the distribution package. So, you do not need to install the module, just enable it on the "Modules" page and configure it to work with your X-Payments installation.

Configuring X-Payments Connector

Before you can start using X-Cart together with X-Payments, you must configure X-Payments Connector.

To configure X-Payments Connector:

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

2. Go to the Modules section (Administration menu -> Modules).

3. If not selected, select the check box for X-Payments Connector and click Update. This will activate the module.

4. Click on the Configure link for X-Payments Connector.

This will open the X-Payments Connector configuration page.

X-paymentsconnector 02.png

5. Define connection details.

  • Copy the value of the Configuration bundle field from the X-Payments' Online Store Details page, paste the string here and click Deploy. All the connection settings will be automatically specified.

The latest versions of X-Payments Connector can automatically get connection settings from the settings of the store. In the older versions, the values are to be specified manually.

  • Store ID: Unique value generated in the X-Payments back-end for a particular store. This value allows X-Payments to correctly identify requests coming from this store.
  • X-Payment URL: The URL of your X-Payments installation. Make sure the URL is specified correctly, otherwise the module will not be able to connect to X-Payments.
  • Encryption key: A key to encrypt requests that the store sends to X-Payments. The key is generated in the X-Payments back-end.
  • Decryption key: A key to decrypt responses and callback requests that the store receives from X-Payments. The key is generated in the X-Payments back-end.
  • Decryption key password: A password to decrypt the Decryption key. The password is generated in X-Payments back-office.
  • IP addresses for X-Payments callbacks: A comma-separated list of X-Payments IP addresses that are used by X-Payments to send callback requests.

6. Establish mapping rules.

Mapping rules are used to synchronize transaction statuses in X-Payments with statuses of respective X-Cart orders. To associate an X-Payments transaction status with an X-Cart order status, choose the order status from the drop-down box in the column on the right.

For example, if you associate the entry "Set order status for 'Charged' payment to" on the right with the value "Processed" from the drop-down box on the left, changing the status of an X-Payment transaction to "Charged" will automatically change the status of the respective order in X-Cart to "Processed".

7. Click the Save button.

Making a test transaction

To test the module settings and connection with X-Payments click the Test module button. If the module is configured properly, a 'Test transaction successfully completed' message is displayed at the top of the page.

Xp-test transaction.gif

Importing X-Payments payment methods into X-Cart

To be able to use the payment methods defined in X-Payments you should import information about them from X-Payments.


First click the Request payment methods from X-Payments button, and X-Payments will return a list of payment methods available for this shopping cart.

Xp-request result.gif

After you have reviewed the list of available payment methods, click Import payment methods and proceed with the next step - adding and enabling X-Payments payment methods in X-Cart admin area.

Please note that if you have already imported payment methods from X-Payments earlier, all previously imported payment methods will be removed from the database if you select to import payment methods again. In this case, you will have to add and enable X-Payments payment methods in X-Cart admin area once again.

Adding X-Payments payment methods

To be able to use X-Payments payment methods, you need to add and enable them in X-Cart admin area.

Note: If you set up PayPal's payment methods via X-Payments in your X-Cart store, please proceed with this special PayPal configuration instruction, and skip the instruction below. Otherwise, in case you set up other payment methods like Authorize.Net AIM or PayflowPro please proceed with the instruction below.
Note: As PayPal requires a special configuration as noted above, PayPal's payment methods imported from X-Payments will NEVER appear in the "Payment Gateways" list under the "Supported via X-Payments..." section. Do not worry about it - you will see them when following the special PayPal configuration instructions as noted above.

Click Settings > Payment methods and use the Payment gateways section to add the payment methods you have configured in X-Payments.

Payment gateways453.png

Starting with X-Cart version 4.5.3, payment gateways in X-Cart are sorted by country, so prior to selecting any payment gateways you will need to select your country from the Your country box. The contents of the Payment gateways selector will be updated to include only the payment gateways available in your chosen country.

Xp payment methods1.png

To add a payment method, choose it from the list in the Payment gateways selector and click Add:

Xp payment methods.png

After the payment method has been added to the list of payment methods in the Payment methods section, activate it by selecting the check box to the left of its name and clicking Apply changes.

You can edit the added X-Payments payment method like all other X-Cart payment methods.

Xp-added method.gif

Enabling lite interface (iFrame support for One-Step-Checkout)

X-Payments connector in X-Cart since v4.5.2 supports loading credit card from from X-Payments via iFrame (aka "lite interface"). Using "lite interface" you can remove a step for entering credit cards in your checkout routine. For your customers it will look like they enter credit card details within your regular checkout routine.

See how it works and how to enable it.

PDF button.png This article can be downloaded as a PDF file