The following is needed before you get started:
Working Installation of nopCommerce.
A server with CURL support — to communicate with the API.
Internet Information Service (IIS) 7.0 or above.
ASP.NET 4.5 (MVC 5.0).
Microsoft .NET Framework 4.5.1 or above.
SSL/HTTPS setup — to keep customer data safe (not required if testing sandbox accounts).
MS SQL Server 2008 or above.
MS SQL Server Compact 4.0 or above.
MS Visual Studio 2012 or above (with MVC 5.0 installed). This is required for developers who want to edit source code.
Installing the Module
This guide assumes that a version of nopCommerce is already installed and running
1. Log in to the admin section of the store and go to Configuration--> Plugins --> All plugins and themes. Enter Simplify Commerce in the Name search field and click Search. This should return the Simplify Commerce Payment Module link. Click the Download button.
2. This link will bring you to the nopCommerce module marketplace (or click here). Click the GET EXTENSION button. You must be logged in to the marketplace in order to download the module.
3. Extract the file that is downloaded and copy the Payments.Simplify folder into the nopCommerce Plugins folder in the directory of the installation it is getting added to.
4. Go back to the Local plugins page: Configuration --> Plugins --> Local plugins. Click the button to Reload list of plugins and the Simplify Commerce module will appear in the list.
Setting up the plugin
1. An account with CommBank Simplify is necessary to set this up.
2. Once installed, the configure button will show up. Click this to set up the module.
3. Once installed, the configure button will show up. Click this to set up the module.
Enable Live Mode – Check this box to enable the gateway for live payments. The live keys must be inputted if this is selected. If live is not selected, then the sandbox keys must be entered. Enabling sandbox mode will allow the testing of orders using the test credit card numbers found here. Sandbox mode does not require an SSL certificate.
Enable Hosted Mode – Tick this box to use CommBank Simplify's secure hosted payment form for your payments. See CommBank Simplify Hosted Payments for more information. If not using hosted payments, SSL must be configured to use the standard payment gateway. A quick description of the different payment modes is as follows:
Payment Mode – Two options on how the card form will appear.
Standard – The card field appears on the checkout page.
Hosted Payments – Hosted Payments must be enabled in the API Keys settings
With SSL: A modal dialog will appear overlaid on the checkout page.
Without SSL: Customers are redirected to CommBank Simplify's secure site to pay. This means a modal dialog will open on a new tab.
The next four entries in the form deal with the API keys. The API keys can be found here on the CommBank Simplify account page that is being used:
Sandbox Public Key – (Test Mode) – Sandbox must be enabled to use this field.
Sandbox Private Key – (Test Mode) – Sandbox must be enabled to use this field.
Live Public Key – This is the live key found on the API Keys section for live payments. SSL is needed if not using hosted payments.
Live Private Key – This is the live key found on the API Keys section for live payments. SSL is needed if not using hosted payments.
Enable Debug Mode – Tick this box to enable debug mode on the module. This can be useful when troubleshooting issues.
4. Once the necessary settings have been input, Click the Save button.
5. To activate and change the order of the appearance of the module on the checkout page, go to Configuration --> Payment --> Payment Methods, tick the Is active checkbox and change the display order of the payment methods. Click the Update button to save these changes. The friendly name of the module can also be changed here.
6. Simplify can now be chosen as a payment option when completing an order.
When testing standard payments, the payments may not complete if there is no email settings input to send emails from the website. This will need to be set up or the emails should be deactivated. This can by deactivating certain email templates in Content management --> Message templates (templates such as OrderPlaced.CustomerNotification).
If there is an API error being received, it should be checked that the correct Public & Private Keys have been input (not test keys and in the correct field) and that Sandbox is disabled.
If the following is coming up in the logs: "invalid or missing timestamp in JWS request message" make sure the time is correct on the server where nopCommerce is installed.
Frequently Asked Questions
Where can I find the change log to see the latest new features and developments for the plugin?
The change log can be found here.
Is CommBank Simplify bundled with nopCommerce?
No it does not come bundled. You will have to install using the instructions above.
I am receiving an error and I don't know why. Where can I find the logs?
The logs can be found in the admin section under System Log.
1800 571 971
+61 7 3224 9711
7 a.m. - 7 p.m. AEST