Difference between revisions of "Draft:X-Cart:Simplify Commerce"

From X-Cart 4 Classic
Jump to: navigation, search
m (Overview)
m
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[https://www.simplify.com/commerce/ '''Simplify Commerce by MasterCard'''] is a payment solution that allows merchants to accept all major brands of debit and credit cards online. The Simplify Commerce module for X-Cart integrates this solution with your online store providing a way to simplify card payments for you and your customers. As a Level 1 PCI certified service provider, Simplify Commerce provides the highest level of protection for your business. <br />
 
[https://www.simplify.com/commerce/ '''Simplify Commerce by MasterCard'''] is a payment solution that allows merchants to accept all major brands of debit and credit cards online. The Simplify Commerce module for X-Cart integrates this solution with your online store providing a way to simplify card payments for you and your customers. As a Level 1 PCI certified service provider, Simplify Commerce provides the highest level of protection for your business. <br />
 
The Simplify Commerce module for X-Cart supports two types of integration:
 
The Simplify Commerce module for X-Cart supports two types of integration:
# ''Simplify Commerce by MasterCard''  in which the payment form is embedded right into your store's checkout page;
+
# ''Simplify Commerce by MasterCard - Simplify Form''  in which the payment form is embedded right into your store's checkout page;
 
# ''Simplify Commerce by MasterCard - Hosted Payments'' in which the payment form is hosted by Simplify Commerce.
 
# ''Simplify Commerce by MasterCard - Hosted Payments'' in which the payment form is hosted by Simplify Commerce.
  
Line 10: Line 10:
 
# [https://www.simplify.com/commerce/login/signup Sign up] for an account on the Simplify Commerce by MasterCard website:<br />[[File:create_sc_account.png|border]]<br /><br />Once you have submitted the sign up form with your details, an email message will be sent to your registration email address with a link allowing you to confirm your email address.<br />You can continue to use the site with Simplify Commerce in Sandbox mode. However, to be able to accept real payments, you will need to activate your Simplify Commerce business account, which requires your email address to be confirmed. Once you have confirmed your email address, you will be able to activate your account by clicking the 'Accept Real Payments' button and following the instructions provided:<br />[[File:accept_real_payments_button.png|border]]<br /><br />
 
# [https://www.simplify.com/commerce/login/signup Sign up] for an account on the Simplify Commerce by MasterCard website:<br />[[File:create_sc_account.png|border]]<br /><br />Once you have submitted the sign up form with your details, an email message will be sent to your registration email address with a link allowing you to confirm your email address.<br />You can continue to use the site with Simplify Commerce in Sandbox mode. However, to be able to accept real payments, you will need to activate your Simplify Commerce business account, which requires your email address to be confirmed. Once you have confirmed your email address, you will be able to activate your account by clicking the 'Accept Real Payments' button and following the instructions provided:<br />[[File:accept_real_payments_button.png|border]]<br /><br />
 
# Get your API keys (These will need to be entered in X-Cart):
 
# Get your API keys (These will need to be entered in X-Cart):
# Enable the Simplify Commerce module at your store:<br />
+
## In your Simplify Commerce account, go to '''Settings''' -> '''API Keys''':<br />[[File:api_keys.png|border]]<br /><br />On the page that opens you will find two keys - one for Sandbox mode and one for Live mode. If you have not yet registered for Live mode, then there will only be a Sandbox key.<br />If necessary, you can create up to five unique Live and Sandbox keys.<br />[[File:generate_new_key.png|border]]<br /><br /> For each key you will be able to specify the following information:
## In the list of your store's installed modules ('''Settings''' -> '''Modules'''), locate the entry for the Simplify Commerce module.[[File:sc_module_disabled.png|border]]<br /><br />
+
##* '''Key Label''': A name that will help you to identify the key.
## Select the check box on the left of the module name.<br />[[File:sc_enable_checkbox.png|border]]<br /><br />The module will be enabled.
+
##* '''Key Type''': Whether this key is for Live or Sandbox mode.
# Configure the module.
+
##* '''Enable hosted payments?''': This option needs to be enabled for keys intended for ''Simplify Commerce by MasterCard - Hosted Payments''.<br />After you have located the API keys that you will need, just leave the page open so you will have the keys at the ready when it is time to copy them to your X-Cart store's back end.
# Activate the Simplify Commerce payment method(s) that you require.
+
# In a new browser tab or window, log in to your X-Cart store's Admin back end and enable the Simplify Commerce module:<br />
:[[File:sc_payment_methods.png|border]]
+
## In the list of your store's installed modules ('''Settings''' -> '''Modules'''), locate the entry for Simplify Commerce.[[File:sc_module_disabled.png|border]]<br /><br />
 +
## Select the check box on the left of the module name.<br />[[File:sc_enable_checkbox.png|border]]<br /><br />The module will be enabled:<br />[[File:sc_module_enabled.png|border]]<br /><br />
 +
# Configure the module:
 +
## Click the '''Configure''' button that has appeared next to the Simplify Commerce entry in the list:<br />[[File:sc_module_configure.png|border]]<br /><br />The Simplify Commerce module configuration page opens:<br />[[File:sc_config_new.png|border]]<br /><br />
 +
## Depending on the type of Simplify Commerce integration you are going to use, adjust the module configuration settings on the "Simplify Form" or the "Hosted Payments" tab (or both).<br />The "Simplify Form" tab is for the ''Simplify Commerce by MasterCard - Simplify Form'' integration:<br />[[File:sc_simplify_form.png|border]]<br /><br />The "Hosted Payments" tab is for the ''Simplify Commerce by MasterCard - Hosted Payments'' integration:<br />[[File:sc_hosted_payments.png|border]]<br /><br />The set of fields on both the tabs is identical:
 +
##* '''Public Key (Live)''' and '''Private Key (Live)''': Use these fields to enter an API key for Live mode from your Simplify Commerce account. '''Important''': For the ''Simplify Commerce by MasterCard - Hosted Payments'' integration, this needs to be a key with the "Enable hosted payments?" property enabled; for the ''Simplify Commerce by MasterCard - Simplify Form'' integration, this needs to be a key with the "Enable hosted payments?" property disabled.
 +
##* '''Order prefix''': If you are using more than one online store with the same Simplify Commerce account, or you are using both the ''Simplify Form'' and the ''Hosted Payments'' integrations simultaneously and want to discriminate between them, you can set a prefix that will be added to orders (for example, "SF-" for orders paid using the ''Simple Form'' integration and "HP-" for orders paid using the ''Hosted Payments'' integration).
 +
##* '''Public Key (Test)''' and '''Private Key (Test)''': Use these fields to enter an API key for Sandbox mode from your Simplify Commerce account. '''Important''': For the ''Hosted Payments'' integration, this needs to be a key with the "Enable hosted payments?" property enabled; for the ''Simplify Form'' integration, this needs to be a key with the "Enable hosted payments?" property disabled.
 +
##* '''Live/Test mode''': Select ''Test'' to run test transactions in Sandbox mode or select ''Live'' to accept real payments. The respective type of API key needs to be entered in the fields above.
 +
# Activate the Simplify Commerce payment method(s) that you require.:[[File:sc_payment_methods.png|border]]
 
:[[File:sc_methods_added_current_session.png|border]]
 
:[[File:sc_methods_added_current_session.png|border]]
 
:[[File:sc_payment_methods_disabled.png|border]]
 
:[[File:sc_payment_methods_disabled.png|border]]

Revision as of 18:42, 27 January 2015

Overview

Simplify Commerce by MasterCard is a payment solution that allows merchants to accept all major brands of debit and credit cards online. The Simplify Commerce module for X-Cart integrates this solution with your online store providing a way to simplify card payments for you and your customers. As a Level 1 PCI certified service provider, Simplify Commerce provides the highest level of protection for your business.
The Simplify Commerce module for X-Cart supports two types of integration:

  1. Simplify Commerce by MasterCard - Simplify Form in which the payment form is embedded right into your store's checkout page;
  2. Simplify Commerce by MasterCard - Hosted Payments in which the payment form is hosted by Simplify Commerce.

Getting started

To start using Simplify Commerce, do the following:

  1. Sign up for an account on the Simplify Commerce by MasterCard website:
    Create sc account.png

    Once you have submitted the sign up form with your details, an email message will be sent to your registration email address with a link allowing you to confirm your email address.
    You can continue to use the site with Simplify Commerce in Sandbox mode. However, to be able to accept real payments, you will need to activate your Simplify Commerce business account, which requires your email address to be confirmed. Once you have confirmed your email address, you will be able to activate your account by clicking the 'Accept Real Payments' button and following the instructions provided:
    Accept real payments button.png

  2. Get your API keys (These will need to be entered in X-Cart):
    1. In your Simplify Commerce account, go to Settings -> API Keys:
      Api keys.png

      On the page that opens you will find two keys - one for Sandbox mode and one for Live mode. If you have not yet registered for Live mode, then there will only be a Sandbox key.
      If necessary, you can create up to five unique Live and Sandbox keys.
      Generate new key.png

      For each key you will be able to specify the following information:
      • Key Label: A name that will help you to identify the key.
      • Key Type: Whether this key is for Live or Sandbox mode.
      • Enable hosted payments?: This option needs to be enabled for keys intended for Simplify Commerce by MasterCard - Hosted Payments.
        After you have located the API keys that you will need, just leave the page open so you will have the keys at the ready when it is time to copy them to your X-Cart store's back end.
  3. In a new browser tab or window, log in to your X-Cart store's Admin back end and enable the Simplify Commerce module:
    1. In the list of your store's installed modules (Settings -> Modules), locate the entry for Simplify Commerce.Sc module disabled.png

    2. Select the check box on the left of the module name.
      Sc enable checkbox.png

      The module will be enabled:
      Sc module enabled.png

  4. Configure the module:
    1. Click the Configure button that has appeared next to the Simplify Commerce entry in the list:
      Sc module configure.png

      The Simplify Commerce module configuration page opens:
      Sc config new.png

    2. Depending on the type of Simplify Commerce integration you are going to use, adjust the module configuration settings on the "Simplify Form" or the "Hosted Payments" tab (or both).
      The "Simplify Form" tab is for the Simplify Commerce by MasterCard - Simplify Form integration:
      Sc simplify form.png

      The "Hosted Payments" tab is for the Simplify Commerce by MasterCard - Hosted Payments integration:
      Sc hosted payments.png

      The set of fields on both the tabs is identical:
      • Public Key (Live) and Private Key (Live): Use these fields to enter an API key for Live mode from your Simplify Commerce account. Important: For the Simplify Commerce by MasterCard - Hosted Payments integration, this needs to be a key with the "Enable hosted payments?" property enabled; for the Simplify Commerce by MasterCard - Simplify Form integration, this needs to be a key with the "Enable hosted payments?" property disabled.
      • Order prefix: If you are using more than one online store with the same Simplify Commerce account, or you are using both the Simplify Form and the Hosted Payments integrations simultaneously and want to discriminate between them, you can set a prefix that will be added to orders (for example, "SF-" for orders paid using the Simple Form integration and "HP-" for orders paid using the Hosted Payments integration).
      • Public Key (Test) and Private Key (Test): Use these fields to enter an API key for Sandbox mode from your Simplify Commerce account. Important: For the Hosted Payments integration, this needs to be a key with the "Enable hosted payments?" property enabled; for the Simplify Form integration, this needs to be a key with the "Enable hosted payments?" property disabled.
      • Live/Test mode: Select Test to run test transactions in Sandbox mode or select Live to accept real payments. The respective type of API key needs to be entered in the fields above.
  5. Activate the Simplify Commerce payment method(s) that you require.:File:Sc payment methods.png
Sc methods added current session.png
Sc payment methods disabled.png
Sc method activate.png
Simplify method1.png



Simplify Commerce by MasterCard

Sc checkout.png
Sc form.png
Sc form1.png
Sc order being placed.png
Sc order receipt.png


Simplify Commerce by MasterCard - Hosted Payments

Sc hosted checkout.png
Sc hosted method selected.png
Sc hosted step1.png
Sc hosted step2.png
Sc hosted step3.png
Sc hosted step4.png
Sc hosted step5.png
Sc hosted step6.png
Sc hosted order receipt.png