How to integrate SafeCharge Payments Plugin for OpenCart

SafeCharge is a global payment technology company that offers a wide range of local and international payment methods to suit your business needs. Correct payment methods at the checkout page can bring you global reach, help you increase conversions, and create a seamless experience for your customers. Our plugin for OpenCart makes it easy for businesses to set up payments while ensuring the security of the transactions. Here you’ll find a step by step procedure to install your payment plugin for OpenCart and start accepting payments.

You can find below:

  • Starting Notes
  • Installation Process
  • Plugin Configuration
  • Checkout Page Experience
  • Order Payment Status Update
  • Order Details
  • Support

 

Starting Notes

Affected Systems

OpenCart with an installed and configured plugin.

Scope of the Document

The document contains instructions on the following topics:

  • SafeCharge OpenCart plugin installation
  • SafeCharge OpenCart plugin basic configuration
  • Basic instructions on the checkout process

Assumptions and Restrictions

Before proceeding to SafeCharge plugin installation you need to have installed OpenCart.

Important – if you are using OpenCart version 2.3.x.x, before install SafeCharge plugin you must install official OpecnCart fix for this version. You can download it from here: https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=27812

The fix will be added in the plugin archive. The SafeCharge plugin should be also installed and configured.

If you don’t have test credentials to test the payment flow, please contact our tech-support team.

Supported Versions

SafeCharge OpenCart plugin is tested on the following versions:

   Oldest supported version Last tested version
OpenCart 2.0.1.0 3.0.3.0

 

 

Installation Process

This procedure describes how to install the SafeCharge plugin using the native OpenCart plugin functionality.

Step 1:Get and extract the proper plug-in for your version of OpenCart.

Step 2: Open the folder XXXX, where XXXX is the version of the OpenCart, get all folders in it (admin, catalog, system) and upload them in your OpenCart root directory.

Step 3: Navigate to Extensions -> Installer and then select “Upload” button. Depending on your OC version, the menu may have a different name. Also, you may or may not have “Install History”

Step 4: Choose the modification file for your version and it will be installed in the system. The success message will be displayed.

Step 5: If your modification file was installed, you will see it in the Extensions -> Modifications menu. Depending on your OC version the menu may have a different name. Here you can enable or disable the modifications. Click on the Refresh button (blue button on the top right) to apply the modifications.

Plugin Configuration

Before setting up SafeCharge OpenCart plugin you should contact Tech-support to provide accounts credentials.

Here’s how to configure the SafeCharge plugin

Step 1: Navigate to Extensions and choose Payments from the select menu – for OC 3.0.1.0 and up. For OC 2 the menu is Extensions -> Payments. From the list of payment methods find SafeCharge and click on the green Pluse button to install the plugin. After the installation, click on the blue Pencil button to edit the settings. After installation the plugin the list will look like the image below.

Step 2: Enter the credentials below:

A few notes for this step in the process.

The default OC settings are not described in the table below.

# Field Name Mandatory Notes
1 Merchant ID yes This is the merchant ID provided by Tech-Support. If you don’t have it, please contact Tech-Support
2 Merchant Site ID yes This is the Merchant Site ID provided by Tech-Support. If you don’t have it, please contact Tech-Support
3 Merchant  Secret key yes This is the secret key provided by Tech-Support. If you don’t have it, please contact Tech-Support
4 Merchant  Hash type yes The hash type provided by Tech-Support. If you don’t have it, please contact Tech-Support
5 Payment API yes The preferd payment API from the merchant (Cashier or REST). If you are not sure about it, please contact Tech-Support
6 Transaction type yes The transaction type prefer form the merchantm provided by Tech-Support. If you don’t have it, please contact Tech-Support
7 Test mode no Enable the payment test mode. Any payments on the test mode are not really processed. Please, do not use real credit card details.
8 Use HTTP Notify URL no If your site is on https server, but you can not receive the DMS, force Notify URL to be http.
9 Enable logs no Create daily logs with sent and received data and settings. The logs are very helpful for debugging and resolving problems with the plugin.
10 Status yes Enable or disable the plugin.
11 Remove Logs Button to delete older logs. Last 30 of them will be kept.

Checkout Page

Step 1: Select a product from your shop and go to the checkout page.

Step 2: Follow the steps of checkout

Step 3: On Payment Method step (its number can be different) select SafeCharge and continue

Step 4: On step Confirm Order you will see order details, and preferred payment methods if you are using the REST API. In this case, a method must be selected and its fields filled. At the end, press Confirm Order button.

 

Step 5: The secure payment page is loaded.

Note: The secured payment page may look different.
If you select “Go Back” button, you are re-directed to your shop checkout page.

Upon successful payment, you are redirected to your shop successful order page.

Order Payment Status Update

Order payment details could be found in Sales -> Orders menu, then click on any order. For each order processed with SafeCharge, there are order trace notes to help track the payment process.

Once the order is saved and the user is redirected to the secured payment page the order status is set to “pending payment”.

After successful payment, the transaction is processed and the order status is updated in the background.

Order Details

This place and the logs (if they are enabled) are the two places where the merchant can see what happen with its order.

In case the merchant flow is “Auth & Settle” (Transaction type option) all new orders will be with status “Pending payment” and under the Items you will find Settle button.

OC v 2.0.1.0

OC v 3.0.3.0

With Settle button, you will settle the Order.

If the merchant flow is “Sell” or the order was Settled, two buttons will be available: Refund and Void. With them, you refund or void your transaction, when order is completed. AS you can see on the image below you must add the amount to refund.

When click on any of the both buttons you will have to confirm your action. After the action complete the notes with information will be created.

For supported refund amount, please contact Tech-Suppor. When click on any of the two buttons, you will have to confirm your action. After the process is finished, the note/s will be saved.

When the refunded amount is equal to order total amount, Order status will change to Refunded. If you void your order, the status will be changed to Canceled.

Anyway, read carefully order Notes!

 

 

Support

Please contact  SafeCharge Tech-Support team in case you have issues installing, configuring or using the SafeCharge OpenCart plugin.

SafeCharge Limited is an Electronic Money Institution authorised and regulated by the Central Bank of Cyprus and is a principal member of Mastercard, Visa and Unionpay International (CUP). SafeCharge Financial Services Limited is authorised and regulated by the Financial Conduct Authority as a Payment Institution. Both SafeCharge companies are wholly owned by SafeCharge International Group Limited.