The following is needed before you get started:
A server with CURL support — to communicate with the API.
Magento 2.1+ — Full Magento technology stack requirements can be found here.
SSL/HTTPS setup — to keep customer data safe (not required if testing sandbox accounts).
Customer account on Magento Marketplace.
Merchant account with CommBank Simplify.
Installing the Module
There are two different ways to install the module so that it appears in the Magento admin panel with the ability to be configured. One way is by using Composer, a PHP package manager and the other is by manual deployment of files onto the location where Magento is installed.
Installation using Composer
1. To download and install the components Composer must be installed. If it's not on the Magento 2 server, install it first. Please follow the instructions specific for the operating system, as specified here. Find more details about installing Composer on specific platforms here:
2. Once Composer is installed, go to the Magento root folder in and use composer to set up the repository by running the following command:
3. Next run the following command to add the module. Note, the username is your Magento Marketplace public key and password is your Magento marketplace private key. You can find them here. Make sure you use the keys for Magento 2 version.
4. The dependencies will be fetched or updated where required – this may take a few minutes. Once the dependencies have all been installed the module needs to be enabled using the following two commands (ran one after another):
5. Once the setup:upgrade command completes the module will be available within the store administration screen to configure.
If the preference is to deploy and install the module without Composer, proceed with the following steps.
1. Download the module files from https://github.com/simplifycom/simplify-magento-module. Make sure to download the latest release, if you're installing for the first time.
2. Create folder structure inside the the Magento main folder:
3. Extract module files into that folder and execute the following commands:
To verify that the installation completed successfully, log in to the Magento Admin dashboard and go to System --> Web Setup Wizard --> Component Manager. The Simplify Commerce module should be there at the end of the list. Make sure that it is enabled.
The status icon should be green. If it is red, the module needs to be enabled, by selecting the Enable action in the actions drop-down on the right.
Uninstalling the module
To uninstall the installed Simplify Commerce Payment Gateway module, the following commands need to be run in the order below:
Configuring the module
1. An account with Commbank Simplify is necessary to set this up.
2. Log in to the Magento administration dashboard. This address should be something like this: http://mywebsite/admin/
3. Go to Stores --> Configuration --> Sales --> Payment Methods.
4 . Expand the drop down menu for OTHER PAYMENT METHODS and select Simplify Commerce by MasterCard. You will then see all of configuration inputs for setting up the Simplify Commerce Payment Gateway.
Enabled: should be set to Yes, to make Simplify Commerce available as payment method on the checkout page.
Title: This is the name of the payment method that will be displayed on the checkout page.
Public API Key: This is a secret key from the Simplify Commerce Merchant Dashboard. For testing the module use the Sandbox key. Once it can be seen that payments from Magento 2 with test credit card numbers are visible in the connected Simplify Commerce Merchant Dashboard, the Live key can only be input then. From this moment payments from real credit cards can be used.
Private API Key: This is the second secret key from Simplify Commerce Merchant Dashboard. The same rules as above apply. The API keys can be found here on the Simplify Commerce account page that is being used.
Display Order: This is the position at which this payment method should be listed on the checkout page.
New Order Status: This is the status assigned to a newly created order, before the payment has been received.
Payment Action: This determines when the buyer's credit card will be charged. If Authorise and Capture is selected, the card will be charged immediately. If Authorise only is selected, the payment will be verified and authorised, but no money will charged yet. The card will only be charged when an invoice is issued for the received order.
Use Simplify Hosted Payments: If Yes is selected, a hosted payment form from Simplify Commerce is used to enter the credit card data. In this scenario no credit card data is ever processed or stored in the Magento 2 system. This is the most secure and recommended solution.
Customer can save credit card: If Yes is selected, the customer can store credit cards in Simplify Commerce for future use. This option is only available when Simplify Hosted Payments are enabled.
Credit Card Types: These are the card types that can be accepted in the online store (Currently Mastercard and Visa are the only options supported).
Accepted Currencies: These are the currencies accepted in the online store (Currently Australian Dollars is the only currency supported).
Payment from Applicable Countries: These are countries from which customers are allowed to be from in order to purchase anything in the online store.
Magento may ask to refresh the cache after configuring and saving the Simplify Module. If this happens, just click on the blue link on the warning message and clear the cache as instructed.
Frequently Asked Questions
Composer is asking me to sign in to repo.magento.com, what are my credentials?
You can find these in your Magento Store account, under Access Keys for Magento 2. The username is the public key and password is the private key.
Where can I find the change log to see the latest new features and developments for the module?
The change log can be found here.
1800 571 971
+61 7 3224 9711
7 a.m. - 7 p.m. AEST