2Checkout Inline for Hikashop

1. Getting Started

This payment plugin provides integration of 2Checkout to Hikashop - a Joomla e-commerce component. 2Checkout is a payment service that provides global payments over 200 markets and let you to maximise online sales. HikaShop is a native E-Commerce extension for all versios of Joomla. It is built for simplicity and flexibility.

Note: 2Checkout payment platform offer several checkout experience to receive funds: Standard Checkout, Inline Checkout and Payment API. This plugin operates as Inline Checkout.

Technical requirements:

  • Joomla 3.6.x+
  • Hikashop 3.0.+
  • Valid SSL certificate

SSL certificate is highly recommended to use to ensure card details of your customers are safe.

2. 2Checkout Dashboard Settings

First of all, you must configure 2Checkout user account and take some settings from there. Sign in to 2Checkout Dashboard, then go to Account > Site Management

There are important settings that must be filled:

  • Demo Setting (Yes, No or Parameter)
  • URL: required parameter. You are able to enter URL one time, so be careful.
  • Pricing currency - set the correct currency
  • Refund Policy and Privacy Policy - refer to your site URLs
  • Direct Return - must be selected to Header Redirect (Your URL)
  • Approved URL - the field must be empty
  • Secret Word - enter your secret word
2Checkout Dashboard settings
2Checkout Dashboard settings
URL must contain your site URL. E.g. [dev.yoursite.com]. It's required field. Please be careful with entering corrent URL since changing the domain name will require additional payment.

Don't forget to set Demo Setting to No for live site and set up correct currency (should be the same as in Hikashop).

If you want to start with Sandbox, please do not forget to enter URL of your dev site during registering the sandbox account.

Registering on 2Checkout sandbox
Don't forget to enter your site URL during the registration

To correct payment processing you need to fill URL in both Live & Sandbox accounts.

2Checkout Dashboard settings
2Checkout Dashboard settings

If you're using Sandbox (demo) mode, it's recommended to add the following URL to Approved URL field:

[youriste.com]/index.php?option=com_hikashop&ctrl=checkout&task=notify&notif_payment=2co_inline&tmpl=component

Approved URL field must be empty for live account! Direct Return param must be set to Header Redirect (Your URL)

Save the changes.

Please bear in mind that Approved URL can't be cleared once you added any value. The value can be changed / updated, but it's unable to clean the field and you get previous value after saving the configuration. We recommend to create Sandbox account for testing purposes and to register Live account for live site. As a result, you will have two accounts.

3. Plugin installation

2Checkout Inline for Hikashop can be installed as typical Joomla extension. Make sure you have downloaded the latest version of the plugin. Go to Administrator panel > Extensions > Manage > Install and select the package downloaded from NorrNext site.

4. Configuring the plugin

4.1. Download Key tab

The plugin has the only setting:

2Checkout Inline for Hikashop - Download key
Download key tab

This feature allow to get an update of the plugin via back-end in few clicks. Set your download key to enable the update using Joomla! Update System. You can find the key in your 2Checkout Inline for Hikashop subscription on the NorrNext website.

If you set the key for the first time or have changed it, please click on the Update Key button to save it for Joomla! Update System.

Read official tutorial: How to enable one-click update for NorrNext commercial extensions

Make sure the plugin is enabled!

5. Adding new payment method to Hikashop

Go to Administrator Panel > Components > Hikashop, then go to System > Payment methods, click on New button and select 2Checkout Inline for HikaShop.

2Checkout Inline for Hikashop - add payment method
Adding 2Checkout as new payment method in Hikashop

You will see payment method settings.

5.1. Main Information

  • Name - name of payment method to be displayed at front-end
  • Description - description to be displayed at front-end

5.2. Generic Configuration

  • Published - (Yes / No). This option allows to publish the method. Set to Yes.
  • Images - list of icons to be displayed at front-end side. You can select what payments are accepted (VISA, Mastercard, PayPal and etc) and display its icons on front-end side. If you want to use custom images, please upload them via FTP to /media/com_hikashop/images/payment/ folder and and you will be able to select them in this option.
2Checkout Inline for Hikashop - Generic Configuration
Generic Configuration: select images and set up price and tax category.
  • Price - set payment fee that will be taken from user for using this payment method.
  • Percentage - payment fee in percents that depends on the total amount of the products in the cart. E.g. your product cost 20€ and you need to take 6%. The payment fee for the payment will be 1.20€.
  • Tax category - select tax category from the list.

5.3. Specific configuration

2Checkout Inline for Hikashop - Specific configuration
Specific configuration: add required 2Checkout params and configure the method
  • Sandbox Mode - Yes / No. If this param is enabled, no real money will be used. You can use Sandbox test data.
  • Seller ID - must be taken from your live 2Checkout account
  • Secret Word - must be taken from your live 2Checkout account
  • Sandbox Seller ID - use seller ID taken from Sandbox account
  • Debug - you can enable debug mode of the payment plugin. The information about each payment will be logged in the payment log file. You can see and modify the location of this file in Hikashop configuration page.
  • Invalid status - here you can select invalid status of the order which could happen when your order has an amount different from the order total or there is different currency. Availalbe options: created, confirmed, cancelled, refunded, shipped, pending. By default it is cancelled.
  • Verified status - here you can select verified status of the order. Availalbe options: created, confirmed, cancelled, refunded, shipped, pending. By default it is cancelled.
  • Cancel url - custom URL to which user will be redirected in case of payment cancellation. It is optional param.
  • Return url - custom URL to which user will be returned after the successful payment. It is optional param.

5.4. Restrictions

2Checkout Inline for Hikashop - Restrictions
Restrictions
  • Zone: You can restrict the check payment method to a zone. By clicking on the edit icon, a popup will open enabling you to select a zone. You can also remove this limitation by clicking on the delete icon.
  • Shipping method: With this option you can select the shipping method for which this payment method will be available. For example, if you choose UPS, this payment method will only be usable if UPS is selected as shipping method. If an other shipping method is selected, this payment method will not be displayed. Note: if you selected "None" or don't select any shipping method, this payment method will always be available.
  • Currency: Choose the currencies allowed by this payment method.
  • Minimum price: The payment method can be available for only orders above a minimum price. This price uses the payment method price currency even if the price is 0.
  • Maximum price: The payment method can be available for only orders below a maximum price. This price uses the payment method price currency even if the price is 0.
  • With tax: Display the payment method only for products with tax.
  • Minimum quantity: If the order has a price lower than the price set in this field, so this payment method will not be available.
  • Maximum quantity: If the order has a price upper than the price set in this field, so this payment method will not be available.
  • Minimum weight: You can set a minimum weight so that orders below it won't be able to be paid with the current payment method. The weight of the order will be calculated based on the weight of each products in it.
  • Maximum weight: You can set a maximum weight so that orders over it won't be able to be paid with the current payment method. The weight of the order will be calculated based on the weight of each products in it.
  • Minimum volume: You can set a minimum volume so that orders below it won't be able to be paid with the current payment method. The volume of the order will be calculated based on the volume of each products in it. The volume is calculated with the width, height and length of the products.
  • Maximum volume: If the order has a volume upper than the price set in this field, so this payment method will not be available.
  • Prefix: You can restrict your payment methods to only post codes including such prefix with this option.
  • Minimum post code: You can restrict your payment methods to only post codes within a certain range whereby this is the minimum possible value
  • Maximum post code: You can restrict your payment methods to only post codes within a certain range whereby this is the maximum possible value
  • Suffix: You can restrict your payment methods to only post codes including such suffix with this option.

5.5. Access level

2Checkout Inline for Hikashop - Access level
Access level

The ACLs are available in the business edition of HikaShop.

  • None: When "none" is selected, the payment method will never be displayed.
  • All: "All" allow you to display the payment method for all the type of users. All groups are allowed to pay via this payment method.
  • Custom: Here you can select which groups can use this payment method. All the checked groups will be able to use this method.

Description of Restrictions and Access Level was taken from official Hikashop documentation.

6. Special Aspects

6.1. 2nd address as required field for some countries

To proceed the payment 2Checkout requires 2nd address for the following countries: Russia, Japan and China. If you sell to these countries, we recommend you to enable custom address_street2 field.

2Checkout Inline for Hikashop - enable 2nd address
Enabling address_street2 in Hikashop

6.2. Change colors in popup iframe

The standard popup window has grey-blue color. You can change it adding new theme and customizing the color. It can be done in live account. Go to 2Checkout Dashboard > Account > Site management and click to Manage Checkout.

2Checkout Inline for Hikashop - Manage checkout
Go to Manage checkout to change the color

There you can select new color schema and preview how the popup window looks like. After saving, you will get new color.

2Checkout Inline for Hikashop - default and custom colors
Example of default and custom colors.

7. Language overrides

You can add custom text at Pay Now page using PLG_HIKASHOPPAYMENT_2CO_INLINE_CUSTOM_MESSAGE language string override. Here is default layout:

2Checkout Inline for Hikashop - Payment page
Payment page. Default layout.

Let's add custom alert with Bootstrap style. Go to Administrator Panel > Extensions > Languages > Override. Select [yourlanguage] - site value in filter and create new constant.

Language Constant: PLG_HIKASHOPPAYMENT_2CO_INLINE_CUSTOM_MESSAGE

Text: add the following HTML code as example:

<div class="alert">
<button type="button" class="close" data-dismiss="alert">×</button>
<strong>Warning!</strong> We do not store your credit card information. It's being processed by 2Checkout.</div>
2Checkout Inline for Hikashop - override language constant
Override language constant

You will get the next result with Bootstrap 2 based template:

2Checkout Inline for Hikashop - enable 2nd address
Payment page. Custom text added via language override.

If you are using another framework, you can modify classes to display alert according to framework standards.

8. F.A.Q.

Does 2Checkout support payment via PayPal?
Yes, if customer has the same e-mail account in PayPal and at your site, a special PayPal button will be appeared during checkout.

Can I use 2Checkout Standard Payment method or Payment API?
No. This plugin operates with Inline checkout only.

What does ERROR CODE:PE101 means?
In rarely cases some users can get such error which means that the bank of has refused the payment. In such case it’s better to repeat the payment after some time or use card issued by another bank.

There is no popup window with iframe when I attempting to pay. I am being redirected to external 2Checkout page.
It happens when some required params are missing. Examples:

  • The order has an amount different from the order total
  • There is different currency in Hikashop and 2Checkout
  • Wrong site URL at 2Checkout dashboard
  • Wrong seller ID
  • You have disabled sandbox mode and forgot to add live seller ID
  • Direct return field is not empty in 2CO live account (see recommendations above).

Please, check out all settings as in Hikashop so in 2Checkout user account carefully.