# Webshop engine integrations

TIP

As with all types of payment processing, we HIGHLY recommend that your payment pages be protected from automated requests. All merchants are required to protect their integrations from fraudlent transactions, including card testing. We recommend using at least one of the following options (there are many others):

  1. Protect payment page behind a login page.
  2. Enable reCAPTCHA reCAPTCHA Details (opens new window)
  3. Enable Fraud Rules from within the gateway to protect in realtime. Please see the gateway control panel for rule recommendations.

# WooCommerce

# Plugin Installation

WARNING

Always backup your system before making any changes or upgrades!

WARNING

After updating to 2.2.0+ if some customers experience that they receive a "Gateway error" message when using an existing saved payment method, it can help if they remove that payment method and add it again.

WARNING

After updating to 2.3.0+, a Run database updates button will appear at the bottom of the "Custom payment gateway" settings page. It's imperative to click it after this update, and any further update that includes database updates.

  1. Download the compressed installation file .
  2. Log in to your Wordpress Admin.
  3. On the Admin Panel click Plugins.
  4. On the top of Plugins page click on "Add New".
  5. On the top of the Add Plugins page click on "Upload plugin".
  6. Press the "Choose File" button to open the downloaded woo-gw.zip file and press the "Install Now" button.
  7. Once installed go to your Plugins page and click on "Activate" under the "GW for WooCommerce" plugin.

# Enabling payment methods

  1. Under the Wordpress Admin Panel click WooCommerce.
  2. Under the Woocommerce Panel click Settings.
  3. Go to the Payments tab.
  4. Two new elements have appeared on the list:
    • Payment Gateway - Credit Card (responsible for handling card payments)
    • Payment Gateway - eCheck (responsible for handling ACH payments)
  5. To enable the payment method, click on the "Enabled" switch

# Plugin Configuration

To get to the settings page, either

  1. Under the Wordpress Admin Panel click "WooCommerce".
  2. Under the Woocommerce Panel click "Custom Payment Gateway".

or

  1. Under the Wordpress Admin Panel click "WooCommerce".
  2. Under the Woocommerce Panel click "Settings".
  3. Go to the "Payments" tab.
  4. Click "Set up" or "Manage" next to either "Payment Gateway - Credit Card" or "Payment Gateway - eCheck" payment method

To configure

  1. Both methods can be configured on the same page, along with some necessary gateway configuration

    1. Gateway

      • API key: the key with which the payment gateway identifies the user of the plugin. The type of the key should be set to "api" in the control panel.
      • URL: the url of the payment gateway without trailing slash or /api at the end

      Once these details have been provided, it's possible to test the API connection with the Test API connection button to ensure proper configuration.

      • Debug log: enable for debugging purposes
    2. Credit Card Payment

      • Title: the displayed title of the payment section at checkout.
      • Description: the displayed description of the payment section at checkout.
      • Transaction type: the chosen type of the transaction. There are two types:
        • Sale (Authorize and Capture)
        • Authorize Only
      • Enable saving of payment methods: enable to allow the customer to save payment details
      • Surcharge, Surcharge type, Surcharge title: Explained below
    3. eCheck Payment

      • Title: the displayed title of the payment section at checkout.
      • Description: the displayed description of the payment section at checkout.
      • Transaction type: the chosen type of the transaction. There are two types:
        • Sale (Authorize and Capture)
        • Authorize Only
      • Enable saving of payment methods: enable to allow the customer to save payment details
  2. Click on "Save changes".

# Base URL

# Integration test

For testing purposes use the url with the corresponding API key.

# Going Live

Change the URL for with the correct API key.

# Surcharge Configuration

  1. Under the Wordpress Admin Panel click WooCommerce.
  2. Under the Woocommerce Panel click Custom Payment Gateway
  3. Surcharge can be configured with these 3 fields:
    • Surcharge: the amount of surcharge in
      • cents (flat calculation)
      • percentage (percentage calculation)
    • Surcharge type:
      • None: no surcharge added to the base amount
      • Flat: the amount is added as a fixed amount to the base amount
      • Percentage: the amount is added as a percentage of the base amount to the base amount
    • Surcharge title: the title displayed for users during Checkout.
  4. Click on "Save changes".

# Example setup for surcharge

  • Percentage the value of 2.10 with the base amount of 10.10 means that the amount of the surchage added to the base amount will be 0.21.
  • Flat with value of 2.10 the surcharge amount will be a flat 2.10 added to the base amount.

# Subscriptions

Starting from v2.1.0, WooCommerce Subscriptions is supported by the plugin.

# Supported features:

  • Simple subscriptions
  • Subscriptions with shipping
  • Subscription cancellation
  • Trial period

# Features on the roadmap (unsupported for now)

  • Sign-up fee
  • Payment method change
  • Subscription suspension and reactivation
  • Mixed checkout (cart containing both normal products and subscriptions)
  • Synchronized renewal (fixed billing dates)

# Configuration

  1. Under the Wordpress Admin Panel click WooCommerce.
  2. Under the Woocommerce Panel click Custom Payment Gateway
  3. To support Woocommerce Subscriptions, tick Enable saving of payment methods at the desired payment method
  4. Click on "Save changes".

# Notes

  • If for some reason the payment method is not available at checkout it's because an unsupported feature is used.

# Magento

# Plugin Installation

WARNING

This module overrides the default checkout messages behavior to disable auto-hiding of messages.

WARNING

This Magento integration only supports credit card payments. ACH and surcharge support is currently under development.

  1. Download the latest release of this module .

  2. Extract the contents to <magento_installation_directory>/app/code/Custom (if code and Custom directories don't exist yet, create them)

  3. Rename the extracted directory to PaymentGateway, the end result should look like this:

     <magento_installation_directory>/app/code/Custom/PaymentGateway
    
  4. Run the following commands to enable the module

     <magento_installation_directory>bin/magento setup:upgrade
     <magento_installation_directory>bin/magento setup:di:compile
    
  5. Validate the installation by running the following command

     grep Custom_PaymentGateway <magento_installation_directory>/app/etc/config.php
    

    The result should look like this:

     'Custom_PaymentGateway' => 1,
    

# Plugin Configuration

  1. Open the Magento Administration page
  2. Select STORES from the menu on the left, then select Configuration
  3. Open the SALES collapsible on the left and select Payment Methods
  4. Scroll down until you find the Custom Payment Gateway collapsible and open it
  5. Change Enabled from No to Yes
  6. Add your API Key
  7. Add the Base URL where the API requests will be sent to.
  8. Click Save Config in the top right corner

# Base URL

# Integration test

For testing purposes use the url with the corresponding API key.

# Going Live

Change the URL for with the correct API key.