Skip to content

Integrating on CubeCart

Locate your humm Credentials

To integrate humm you will need your

  • Merchant Number
  • API Key

This document outlines the steps needed to install humm on your CubeCart Store.

humm was tested against CubeCart version 6.1.1, however, should be compatible against other versions.

Installing humm

The plugin can be installed via CubeCart's Admin Control Panel, either manually or automatically using a Token. This section details how to upload the plugin, and install and configure its various parameters for it to work properly.

If you have trouble accessing your CubeCart's Admin Control Panel, please consult CubeCart's official knowledgebase and forums, or your IT department to resolve the issue.

Automatic Installation using Token

1 - Navigate to the following URL.

https://www.cubecart.com/extensions/payment-gateways/oxipay

2 - Select the lightning bolt button, next to your required humm plugin version, to reveal the Auto Install/Upgrade Token

autoinstall-1.png

3 - Copy the Token from within the pop-up.

autoinstall-2.png

4 - Log into the CubeCart Admin Control Panel as an Administrator.

autoinstall-3.png

5 - Once logged in, you will be presented with your Store's dashboard. From the side menu that appears to the left, scroll to the Extensions section and select Manage Extensions.

autoinstall-4.png

6 - Copy the Auto Install/Upgrade Token into the Token field on the Manage Extensions page and select the Go button.

autoinstall-5.png

7 - If the module has been installed correctly, the module will appear in the list of Available Extensions.

autoinstall-6.png

If the automatic installation is not successful, you will be presented with a message at the top of the page similar to the screenshot below. If this continues to be a problem, please refer to the Manual Installation procedure.

autoinstall-7.png

Manual Installation

1 - Navigate to the following URL.

https://www.cubecart.com/extensions/payment-gateways/oxipay

2 - Select the download button , next to your required humm plugin version, to download the humm plugin ZIP file.

manualinstall-1.png

3 - Extract the ZIP file and copy the contents to the modules/gateway folder of your server’s/site directory.

4 - Ensure the folders/files have adequate read/write permissions set.

5 - Log into the CubeCart Admin Control Panel as an Administrator.

manualinstall-2.png

6 - Once logged in, you will be presented with your Store's dashboard. From the side menu that appears to the left, scroll to the Extensions section and select Manage Extensions.

manualinstall-3.png

7 - If the module has been installed correctly, the module will appear in the list of Available Extensions.

manualinstall-4.png

Configuring humm

This section describes the Module Settings available once you have installed the humm plugin. This includes the humm gateways to communicate with, as well as whether or not to enable Test Mode.

1 - Log into the CubeCart Admin Control Panel as an Administrator.

2 - Once logged in, you will be presented with your Store's dashboard. From the side menu that appears to the left, scroll to the Extensions section and select Manage Extensions.

3 - Under the Available Extensions section, select the text Humm to configure the module settings. Descriptions of the options are listed below.

config-1.png

We have intentionally masked the Merchant ID and API Key in this support document. Please contact us and we will advise you of the settings to use.


  • Status This must be enabled for the payment options to appear during checkout.


  • Priority If you have more than one payment gateway, please use this field to define the order they are shown in. A setting of '1' will show it first, '2' second, etc.


  • Scope This allows you to specify whether you want the humm plugin to be available via the Main Website only or the Mobile Website only, or both.


  • Default This must be enabled if you would like humm pre-selected for the Customer as the default payment option.


  • Merchant ID This is the humm Merchant ID that you are provided with as part of your on-boarding when signing-up for humm.


  • API Key The API Key or the Encryption key is a case-sensitive alpha-numeric sequence that is used to authenticate payment requests originating from your Store. It is vital that you protect it and don't provide it to unauthorised individuals.


  • Test Mode Indicates whether to process payments over the live humm Gateway URL resulting in real transactions, or to process it over the humm Sandbox Gateway URL which will produce simulated (test) transactions with no real dollar amounts being debited. By default it should be set to No unless we are attempting to diagnose issues on your store to do with humm, or you're testing integrating the plugin with your online CubeCart store.


  • Test Gateway URL This specifies the test humm end-point that the plugin would need to communicate with when Test Mode is enabled. This is mainly used for troubleshooting purposes, particularly if we want to simulate test transactions on your CubeCart Store without having real dollar amounts debited from Credit Cards.


  • Gateway URL This specifies the live humm end-point that the plugin would need to communicate with for it to be able to process payments via humm. Note that transactions processed over this URL are real transactions that end up in real dollar amounts being deducted.


4 - Once you have finished making the necessary configuration changes, click the Save button.

5 - Australia will be automatically set as an Enabled Region in the Allowed Zones tab. This must match the Country set in the CubeCart Store Settings.

config-2.png



Upgrading humm

Automatic Upgrade

Importantly, when you perform an automatic upgrade, all the module settings are retained. That is, you do not need to type in your Merchant ID and API Key again.

1 - Navigate to the following URL.

https://www.cubecart.com/extensions/payment-gateways/oxipay

2 - Select the lightning bolt button, next to your required humm plugin version, to reveal the Auto Install/Upgrade Token

autoinstall-1.png

3 - Copy the Token from within the pop-up.

autoinstall-2.png

4 - Log into the CubeCart Admin Control Panel as an Administrator.

autoinstall-3.png

5 - Once logged in, you will be presented with your Store's dashboard. From the side menu that appears to the left, scroll to the Extensions section and select Manage Extensions.

autoinstall-4.png

6 - Copy the Auto Install/Upgrade Token into the Token field on the Manage Extensions page.

autoinstall-5.png

7 - If you enable the option to Backup if already exists, a backup of the previous plugin version will be created.

8 - Select the Go button to complete the upgrade.


Manual Upgrade

Prior to manually upgrading, you will first need to un-install the previous version.

Un-installing humm

1 - Log into the CubeCart Admin Control Panel as an Administrator.

uninstall-1.png

2 - Once logged in, you will be presented with your Store's dashboard. From the side menu that appears to the left, scroll to the Extensions section and select Manage Extensions.

uninstall-2.png

3 - In the list of Available Extensions, select the delete button associated with the Humm extension.

4 - If the module has been un-installed correctly, the module will no longer appear in the list of Available Extensions.

uninstall-3.png

5 - You can now download the new version of the humm CubeCart plugin and install it as per the instructions in the Installing humm section of this document.