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

From X-Cart 4 Classic
Jump to: navigation, search
m
m (Redirected page to X-Cart:Simplify Commerce)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
#REDIRECT [[X-Cart:Simplify Commerce]]
 +
 
==Overview==
 
==Overview==
 +
 
[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 - Simplify Form''  in which the payment form is embedded right into your store's checkout page;
+
# ''Simplify Commerce by MasterCard - Payment 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.
  
==Getting started==
+
==Configuration==
  
 
To start using Simplify Commerce, do the following:
 
To start using Simplify Commerce, do the following:
Line 13: Line 16:
 
##* '''Key Label''': A name that will help you to identify the key.
 
##* '''Key Label''': A name that will help you to identify the key.
 
##* '''Key Type''': Whether this key is for Live or Sandbox mode.
 
##* '''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''.<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.
+
##* '''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.<br /><br />
 
# 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 />
 
# 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 />
 
## 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 />
 
## 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 />
Line 19: Line 22:
 
# Configure the module:
 
# 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 />
 
## 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 />
## If you are going to use the ''Simplify Commerce by MasterCard - Simplify Form'' integration, focus on the "Simplify Form" tab:<br />[[File:sc_simplify_form.png|border]]<br /><br />If you are going to use the ''Simplify Commerce by MasterCard - Hosted Payments'' integration, switch to the "Hosted Payments" tab:<br />[[File:sc_hosted_payments.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 - Payment 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?" feature enabled; for the ''Simplify Commerce by MasterCard - Payment Form'' integration, this needs to be a key with the "Enable hosted payments?" feature disabled.
# Activate the Simplify Commerce payment method(s) that you require.:[[File:sc_payment_methods.png|border]]
+
##* '''Order prefix''': If you are using more than one online store with the same Simplify Commerce account, or you are using both the ''Payment 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).
:[[File:sc_methods_added_current_session.png|border]]
+
##* '''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?" feature enabled; for the ''Payment Form'' integration, this needs to be a key with the "Enable hosted payments?" feature disabled.
:[[File:sc_payment_methods_disabled.png|border]]
+
##* '''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.<br /><br />
:[[File:sc_method_activate.png|border]]
+
# Activate the Simplify Commerce payment method(s) that you require.<br /><br />Once the Simplify Commerce module has been enabled in your store, you should be able to find two new payment methods in the Payment methods section ('''Settings''' -> '''Payment methods'''):<br />- Simplify Commerce by MasterCard (Background method);<br />- Simplify Commerce by MasterCard - Hosted Payments (Web based method)<br /><br />If you visit your store's Payment methods section during the same session in which the module has been enabled, at the top of the page you will see the quick links to these methods:<br />[[File:sc_methods_added_current_session.png|border]]<br /><br />Provided that you have completed Step 4 ("Configure the module") of this procedure, you have already configured the method(s) that you are going to use. However, if necessary, you can go back to Simplify Commerce module configuration settings by clicking on the <u>Configure</u> link for any of the two Simplify Commerce payment methods and adjust the settings as needed.<br /><br />To make Simplify Commerce methods available to buyers, you now need to enable them:
:[[File:simplify_method1.png|border]]
+
## Scroll down the page to the bottom of the payment method list to locate the Simplify Commerce payment methods that have been added:<br />[[File:sc_payment_methods_disabled.png|border]]
<br />
+
## Select the check box next to the name of the method you want to enable (Select the check boxes for both the methods if you want to enable both).
 +
## If you want to change the name under which your selected method should appear to customers, add an extra charge, provide comments/instructions for customers or make the method available only to certain membership levels, you can do so by adjusting the appropriate fields. If you have multiple payment methods enabled, make sure order number of your selected  Simplify Commerce payment method is adjusted properly.
 +
## Click the '''Apply changes''' button for the changes to be applied.<br />:[[File:sc_method_activate.png|border]]<br /><br />The selected method(s) will be activated:<br />:[[File:simplify_method1.png|border]]<br /><br />
 +
That is all. Now you can accept payments via the Simplify Commerce method(s) you have enabled.<br /><br />
 +
 
 +
==Admin experience==
 +
The store administrator knows that an order was paid for via Simplify Commerce by looking at the order details:
 +
::[[File:sc_order.png|border]]<br /><br />
 +
Currently X-Cart's Simplify Commerce integration supports only ''Payment'' transactions in which money is taken from the buyer's account and moved to the store's account immediately on confirmation; ''Authorization and Capture'' transactions in which the money is authorized, but its capture is delayed until a later time are not supported. <br /><br />
 +
Refund transactions via the X-Cart store's back end are also not supported; if a refund needs to be issued for a payment done via a Simplify Commerce payment method, the store administrator must issue it via the payment gateway.
 +
 
 +
==Customer experience==
  
 +
===Payments via Simplify Commerce by MasterCard - Payment Form===
  
Simplify Commerce by MasterCard
+
When you enable payments via ''Simplify Commerce by MasterCard - Payment Form'' for your customers, the respective payment method is added to the list of available payment options at checkout:
:[[File:sc_checkout.png|border]]
+
::[[File:sc_checkout.png|border]]<br /><br />
:[[File:sc_form.png|border]]
+
By default, the name of this method is ''Simplify Commerce by MasterCard'', but it may be different if you have changed it in the payment method settings in your store's Admin back end.<br />
:[[File:sc_form1.png|border]]
+
When a customer selects this method for payment, a Secure credit card payment form is expanded:
:[[File:sc_order_being_placed.png|border]]
+
::[[File:sc_form.png|border]]<br /><br />
 +
(Note that this form is embedded into your store's checkout page, and the customer does not have to leave your site to make payment).<br /><br />
 +
The customer completes the form with their payment card information and submits the order by clicking the '''Submit order''' button:
 +
::[[File:sc_form1.png|border]]
 +
The data submitted through the Secure credit card payment form is not stored on the store's server, but is converted to a single-use token, which is then submitted to the Simplify Commerce's server and used to safely charge the customer:
 +
:[[File:sc_order_being_placed.png|border]]<br /><br />
 +
When a confirmation of the successful payment transaction is received, the customer gets a confirmation of the successful creation of the order. The customer's receipt shows the payment method that has been used:
 
:[[File:sc_order_receipt.png|border]]
 
:[[File:sc_order_receipt.png|border]]
 
<br />
 
<br />
  
Simplify Commerce by MasterCard - Hosted Payments
+
===Payments via Simplify Commerce by MasterCard - Hosted Payments===
:[[File:sc_hosted_checkout.png|border]]
+
When you enable payments via ''Simplify Commerce by MasterCard - Hosted Payments'' for your customers, the respective payment method is added to the list of available payment options at checkout:
:[[File:sc_hosted_method_selected.png|border]]
+
::[[File:sc_hosted_checkout.png|border]]<br /><br />
:[[File:sc_hosted_step1.png|border]]
+
By default, the name of this method is ''Simplify Commerce by MasterCard - Hosted Payments'', but it may be different if you have changed it in the payment method settings in your store's Admin back end.<br /><br />
:[[File:sc_hosted_step2.png|border]]
+
When a customer selects this method for payment, they may either be provided with a payment form in a modal dialog right on your website or redirected to a secure payment page on Simplify.com. Whether the customer is redirected to Simplify.com or stays on your site is determined by Simplify Commerce's JavaScript according to what's best for the customer security.<br /><br />
:[[File:sc_hosted_step3.png|border]]
+
The screenshots below demonstrate the payment process with the customer being redirected to Simplify Commerce.<br /><br />
:[[File:sc_hosted_step4.png|border]]
+
Here you can see the instructions provided to the customer when they have selected the payment method corresponding to the ''Simplify Commerce by MasterCard - Hosted Payments'' integration and are going to be redirected away from the X-Cart store site to use a secure payment form on Simplify.com:
:[[File:sc_hosted_step5.png|border]]
+
::[[File:sc_hosted_method_selected.png|border]]<br /><br />
:[[File:sc_hosted_step6.png|border]]
+
After the customer submits the order, they are redirected to the Simplify Commerce's site to make the payment:
:[[File:sc_hosted_order_receipt.png|border]]
+
::[[File:sc_hosted_step1.png|border]]
 +
::[[File:sc_hosted_step2.png|border]]
 +
::[[File:sc_hosted_step3.png|border]]<br /><br />
 +
Soon enough they find themselves on the secure (HTTPS) page on Simplify.com where the payment form is hosted:
 +
::[[File:sc_hosted_step4.png|border]]
 +
After completing the form fields with their payment card information, the customer needs to submit the form by clicking '''Pay''':
 +
::[[File:sc_hosted_step5.png|border]]<br /><br />
 +
Simplify Commerce processes the submitted information:
 +
::[[File:sc_hosted_step6.png|border]]<br /><br />
 +
Once the transaction has been completed successfully, the customer is provided with a confirmation and a receipt. The receipt shows the payment method that has been used:
 +
::[[File:sc_hosted_order_receipt.png|border]]

Latest revision as of 16:36, 29 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 - Payment 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.

Configuration

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 - Payment 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?" feature enabled; for the Simplify Commerce by MasterCard - Payment Form integration, this needs to be a key with the "Enable hosted payments?" feature disabled.
      • Order prefix: If you are using more than one online store with the same Simplify Commerce account, or you are using both the Payment 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?" feature enabled; for the Payment Form integration, this needs to be a key with the "Enable hosted payments?" feature 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.

    Once the Simplify Commerce module has been enabled in your store, you should be able to find two new payment methods in the Payment methods section (Settings -> Payment methods):
    - Simplify Commerce by MasterCard (Background method);
    - Simplify Commerce by MasterCard - Hosted Payments (Web based method)

    If you visit your store's Payment methods section during the same session in which the module has been enabled, at the top of the page you will see the quick links to these methods:
    Sc methods added current session.png

    Provided that you have completed Step 4 ("Configure the module") of this procedure, you have already configured the method(s) that you are going to use. However, if necessary, you can go back to Simplify Commerce module configuration settings by clicking on the Configure link for any of the two Simplify Commerce payment methods and adjust the settings as needed.

    To make Simplify Commerce methods available to buyers, you now need to enable them:
    1. Scroll down the page to the bottom of the payment method list to locate the Simplify Commerce payment methods that have been added:
      Sc payment methods disabled.png
    2. Select the check box next to the name of the method you want to enable (Select the check boxes for both the methods if you want to enable both).
    3. If you want to change the name under which your selected method should appear to customers, add an extra charge, provide comments/instructions for customers or make the method available only to certain membership levels, you can do so by adjusting the appropriate fields. If you have multiple payment methods enabled, make sure order number of your selected Simplify Commerce payment method is adjusted properly.
    4. Click the Apply changes button for the changes to be applied.
      :Sc method activate.png

      The selected method(s) will be activated:
      :Simplify method1.png

That is all. Now you can accept payments via the Simplify Commerce method(s) you have enabled.

Admin experience

The store administrator knows that an order was paid for via Simplify Commerce by looking at the order details:

Sc order.png

Currently X-Cart's Simplify Commerce integration supports only Payment transactions in which money is taken from the buyer's account and moved to the store's account immediately on confirmation; Authorization and Capture transactions in which the money is authorized, but its capture is delayed until a later time are not supported.

Refund transactions via the X-Cart store's back end are also not supported; if a refund needs to be issued for a payment done via a Simplify Commerce payment method, the store administrator must issue it via the payment gateway.

Customer experience

Payments via Simplify Commerce by MasterCard - Payment Form

When you enable payments via Simplify Commerce by MasterCard - Payment Form for your customers, the respective payment method is added to the list of available payment options at checkout:

Sc checkout.png

By default, the name of this method is Simplify Commerce by MasterCard, but it may be different if you have changed it in the payment method settings in your store's Admin back end.
When a customer selects this method for payment, a Secure credit card payment form is expanded:

Sc form.png

(Note that this form is embedded into your store's checkout page, and the customer does not have to leave your site to make payment).

The customer completes the form with their payment card information and submits the order by clicking the Submit order button:

Sc form1.png

The data submitted through the Secure credit card payment form is not stored on the store's server, but is converted to a single-use token, which is then submitted to the Simplify Commerce's server and used to safely charge the customer:

Sc order being placed.png

When a confirmation of the successful payment transaction is received, the customer gets a confirmation of the successful creation of the order. The customer's receipt shows the payment method that has been used:

Sc order receipt.png


Payments via Simplify Commerce by MasterCard - Hosted Payments

When you enable payments via Simplify Commerce by MasterCard - Hosted Payments for your customers, the respective payment method is added to the list of available payment options at checkout:

Sc hosted checkout.png

By default, the name of this method is Simplify Commerce by MasterCard - Hosted Payments, but it may be different if you have changed it in the payment method settings in your store's Admin back end.

When a customer selects this method for payment, they may either be provided with a payment form in a modal dialog right on your website or redirected to a secure payment page on Simplify.com. Whether the customer is redirected to Simplify.com or stays on your site is determined by Simplify Commerce's JavaScript according to what's best for the customer security.

The screenshots below demonstrate the payment process with the customer being redirected to Simplify Commerce.

Here you can see the instructions provided to the customer when they have selected the payment method corresponding to the Simplify Commerce by MasterCard - Hosted Payments integration and are going to be redirected away from the X-Cart store site to use a secure payment form on Simplify.com:

Sc hosted method selected.png

After the customer submits the order, they are redirected to the Simplify Commerce's site to make the payment:

Sc hosted step1.png
Sc hosted step2.png
Sc hosted step3.png

Soon enough they find themselves on the secure (HTTPS) page on Simplify.com where the payment form is hosted:

Sc hosted step4.png

After completing the form fields with their payment card information, the customer needs to submit the form by clicking Pay:

Sc hosted step5.png

Simplify Commerce processes the submitted information:

Sc hosted step6.png

Once the transaction has been completed successfully, the customer is provided with a confirmation and a receipt. The receipt shows the payment method that has been used:

Sc hosted order receipt.png