How to integrate SafeCharge Payments Plugin for WooCommerce

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 WooCommerce 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 WooCommerce 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

WordPress with installed and configured WooCommerce plugin.

Scope of the Document

The document contains instructions on the following topics:

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

Assumptions and Restrictions

Before installing the SafeCharge plugin, you need to have WordPress installed. The WooCommerce module should also be installed and configured.

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

Supported Versions

SafeCharge WooCommerce plugin was tested on the following versions:

 Oldest Supported Version  Late Tested Version
WordPress v4.7.3 5.0.1
WooCommerce v3.0.0 v3.5.2

 

 

Installation Process

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

Step 1: Log in to WordPress backend with your credentials.

Step 2: Navigate to Plugins -> Installed Plugins and then click the “Add New” button.

Step 3: Select the plugin archive and install it.

Step 4: After successful installation, you should see the status “Plugin Activated”.

Plugin Configuration

Before setting up SafeCharge WooCommerce plugin, you should contact our Integration team to provide account credentials.

Here’s how to configure the SafeCharge plugin

Step 1: Navigate to WooCommerce -> Settings.

Step 2: Select the Payment tab and then under “Pay with SafeCharge”, click the Set up button.

Step 3: Enter the credentials as below:

A few notes for this step in the process.

# Field Name Mandatory Notes
1 Enable/Disable no Enables or disables the SafeCharge plugin
2 Title yes The name of the payment option in your checkout page
3 Description no Short description what payment options SafeCharge provide to the users
4 Merchant ID yes This is the merchant ID provided by Integration team. If you don’t have it, please contact Integration
5 Merchant Site ID yes This is the Merchant Site ID provided by Integration. If you don’t have it, please contact Integration
6 Secret key yes This is the secret key provided by Integration. If you don’t have it, please contact Integration
7 Hash type yes The hash type provided by Integration. If you don’t have it, please contact Integration
8 Payment API yes The preferred payment API from the merchant (Hosted Payment page or REST). If you are not sure about it, please contact Integration
9 Transaction type yes The preferred transaction type form the merchant provided by Integration. If you don’t have it, please contact Integration
10 Test mode no Enable the payment test mode. Any payments on the test mode are not actually processed. Please, do not use real credit card details.
11 Use HTTP no If your site is on an https server, but you cannot receive the DMS, force Notify URL to be http.
12 Rewrite DMN no This option is in case your WP site has problems with “+”, ” ” and “%20” symbols in the URL. The above symbols will be replaced with “_”. Use with caution, and after testing.
13 Use WPML “Thank you” page. no This option works only when you have the WPML plugin installed and configured, and WPML for WooCommerce. As above option, use it only if you have a problem with the default notify URL. Use with caution, and after testing.
14 Show loading message no When selected, a loading message is shown while redirecting to the secure cashier payment page.
15 Save logs no Creates daily logs with sent and received data and settings. The logs are very helpful for debugging and resolving problems with the plugin.
16 Delete oldest logs When you click this button and you have log files, all except the last 30 files are deleted.

 

Checkout Page

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

Step 2: Enter your billing details.

Step 3: Select a billing country. If you use REST API for Payment API, you see all possible payment options per country.

Once the user is redirected to the secure payment page, additional options are available.

 

Step 4: 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.

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

Order Payment Status Update

Order payment details can be found in WooCommerce -> Orders menu, 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 changes to “pending payment“.

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

Note: To have your order payment status updated, you should have URL {your_domain}?wc-api=sc_listener enabled for public use.

Order Details

The Order Details page and the logs (if they are enabled) are the two places where the merchant can see what happened with an order.

In case the merchant flow is “Auth & Settle” (Transaction type option), all new orders have status “Pending payment” and under the Items, you see two buttons: Refund and Settle.

 

Use the Settle button to settle the Order and use the Refund button to request a refund. For each button, you must confirm your action. After the action completes, notes with information are created.

If the merchant flow is “Sell” or the order was Settled, the following two buttons are available: Refund and Void. With them you can either request a refund or void your transaction.

Since version 1.9.2, two Refund buttons are available:

  • Refund manually – Creates a refund record only in the Woocommerce system. Use this button if you already made your refund in CPanel, and you only wish to have the same record in the site.
  • Refund via SafeCharge – Creates a refund in the Woocommerce system and creates a refund request in the SafeCharge system.

For supported refund amount, please contact Integration. For each button, you must confirm your action. After the process is finished, the notes are saved.

When the refunded amount is equal to the total order amount, WooCommerce changes the status to Refunded. If you void your order, the status is changed to Canceled.

If your refund is rejected for some reason, you must manually delete the created Refund record.

Read the order notes carefully!

 

Support

Please contact SafeCharge Integration in case you have issues installing, configuring or using the SafeCharge WooCommerce 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.