OpenCart
Omise’s payment extension for OpenCart diminishes your daily tasks by automating the entire payment process. The extension allows you to accept payment through credit or debit card directly on your site without having to write a single line of code, or the customer being redirected offsite.
Get the source code repository at github.com/omise/omise-opencart
Requirements and Installation:
OpenCart Version Compatibility
- OpenCart 1.5.6.4
Dependencies
- Omise-PHP (v2.1.2)
- jQuery (v1.7.1 from OpenCart (v1.5.6.4)'s dependency)
- vqmod (v2.5.1 with OpenCart integration edition)
Installation
Here's what to do:
Download the repository and unzip it to your local machine or directly to your server using either one of these links:
omise-opencart.zip or
omise-opencart.tar.gz
Go to
/omise-opencart/src
and copy all files to your OpenCart ProjectOpen your OpenCart site and go to the
/admin
pageSelect
Extensions
>Payments
(from the top menu), in the payment extension list page
Look for Omise Payment Gateway
and click Install
Provided that all went well, Omise
will appear on the top right of your admin page.
Troubleshooting
Permissions must be set so that omise-opencart can overwrite the following files:
- your-opencart(root)/index.php
- your-opencart(root)/admin/index.php
It also creates new folders and files on your-opencart(root)/
directory for the first installation.
Ensure these 2 files and folder have appropriate write
permissions (usually 755
).
Omise Keys Setup
In order to use omise-opencart you have to first link it to your Omise account using your credentials:
Go to
Omise
>Settings
Fill in and save your
Omise Keys
. If you'd like to test our service and learn how things work, you can do so by clickingEnable test mode
. This puts your test keys in use. Note that the set of keys you use determines whether actual money will be transferred or not.
The Module config allows you to enable or disable our payment gateway on your OpenCart site.
Checking out with Omise
After setting up your Omise keys, you can now start checking out with Omise Payment Gateway. In order to test it, make sure you set up your test keys and enable test mode.
Start off by heading over to your website and add items to the shopping cart.
From the cart, go through the regular checkout procedure. Pay attention to step 5 Payment Method
You'll find Credit Card (Powered by Omise). Select it and check
I have read and agree to the terms & conditions
.
You'll be asked to fill out the form with card details. For those in test mode, you can select a test card from our docs.
Once done, submit your order with the
Confirm Order
button. If you'd like to learn more about how cards are collected and processed, check out our documentation: Collecting Cards and Charging Cards)Once complete, you'll be redirected to the following page.
Over at the
admin dashboard
you'll find the order marked asProcessed
.
Note: During authorization (a very short period!), the order status will be marked asProcessing
Uninstalling Omise
As there's no method of automatically checking whether vQmod
is being used by another extension or not, it is required that you manually uninstall the plugin from your server source code. Follow these steps:
- Uninstall the extension via the extension list page
- Remove the vQmod folder from your OpenCart directory
1. Uninstall Omise Payment Gateway extension
Open your OpenCart website and go to the
/admin
pageGo to
Extensions
>Payments
Look for
Omise Payment Gateway
and click Uninstall
Once done, Omise
will disappear from the top right of your admin page.
2. Removing vQmod library
Make sure that you're not using vQmod
in other extensions. If you're uncertain, it's alright to leave it there. It won't do any harm to your site.
In your OpenCart directory you'll find the
vqmod
folder. Remove it
Go to
omise-opencart/backup
and restore the backup files.
Copy and paste them to your OpenCart site
- omise-opencart/backup/index.php
to your-opencart(root)/index.php
- omise-opencart/backup/admin/index.php
to your-opencart(root)/admin/index.php