Configure the connection in the Admin area of your X-Cart 5 store
page last edited on 31 October 2017
The following procedure assumes that your X-Cart 5 store has the X-Payments connector module installed and enabled.
Complete the following steps:
- Log in to the Admin panel of your X-Cart 5 store.
- Go to the Installed Modules section and in the list of your store’s installed modules locate the entry for X-Payments connector.
Click the Settings button next to the module name: The module settings page opens.
- On the “X-Payments connector” module settings page, select the Connection tab to access your store’s connection settings:
Now it is time to use the configuration bundle you have copied from your X-Cart 5 store’s details page in the X-Payments admin back end. Paste the configuration bundle into the appropriate field on the “X-Payments connector” module settings page in X-Cart and click Deploy: The module will take a few moments to deploy the configuration. Once the process is complete, you will see a success message at the top of the screen saying “Test transaction has been completed successfully for API version X. Payment methods have been imported successfully. Configuration has been successfully deployed.”
So, now your X-Payments installation is connected to your X-Cart store.
You should now be able to see a list of payment methods that have been imported into your X-Cart store from X-Payments: (You will only see the methods you have configured in X-Payments as payment configurations).
Enable the payment methods you are going to use by clicking the On/Off control to the left of the respective method names (green icon = enabled). As you can see, we have quite a number of methods that have been imported, but we are not going to use all of them in one store; we’ll just enable the First Data Payeezy Gateway method: 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 Save cards option (the check box in the far right column): Once you’re done, be sure to save your changes using the Save changes button.
Go to the Order status mapping rules section and map your X-Cart store order statuses with X-Payments transaction statuses. Be sure to click Submit to save your changes.
- Use the Save credit card setup section to set the payment method that you want your customers to use when they choose to save their credit card in their front end accounts.
- To enable your customers to pay for orders using a card they saved in their front end user account or a card they saved while placing another order through X-Payments, you need to enable the Use a saved credit card payment method. 1. Go to the Payment settings page (Store setup > Payment methods) where your configured X-Payments payment methods appear and choose to add a new payment method: 2. In the popup window that appears, search for the method titled “Use a saved credit card”: 3. Once the method has been found, click the Add button opposite its name to add it to the list of your store’s payment methods. 4. Enable the method you have added by setting the INACTIVE/ACTIVE switch for it to ACTIVE:
- If you want the X-Payments credit card form to appear as embedded in your X-Cart store’s checkout page, enable the Use iframe option in the Connection section of the “X-Payments connector” module settings page: Please note that if you enable this option in X-Cart, you must also select an iframe based template for your X-Cart 5 store in the X-Payments admin back end.
That’s it. Now you are all set and ready to process payments in your X-Cart 5 store using X-Payments.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub.