Magento 2

Solidifying your checkout experience can really be hassle-free. The Omise payment extension comes complete with powerful payment features that allows you to easily accept online payments on your store.

Supported Versions

Our aim is to support as many versions of Magento as we can.

Here's the list of versions we tested on:

  • Magento (CE) 2.1.5 on PHP 7.0.16.

Legacy Support

For merchants looking for support for Magento (CE) 1.x series, please check Magento 1 document.

Can't find the version you're looking for?
To report problems for the version you're using, feel free to submit requirements or issues to support@omise.co

Getting Started

Installation Instructions

Manually

The steps below shows how to install the module manually. This requires a user account with permission to write your Magento file system, execute the command line and composer.

  1. Download and extract the zip file from Omise-Magento.

  2. On your Magento server, create a new folder Omise/Payment under the directory app/code.

  3. Copy all files to the directory app/code/Omise/Payment that you created in the step 2. omise-magento-2 Manual Install 01

  4. Log in to your Magento server by using Terminal program, then change the current directory to your Magento root directory.

  5. Execute command composer require omise/omise-php:2.8.0 to install Omise-PHP library.

  6. Execute php bin/magento module:enable Omise_Payment --clear-static-content to register Omise_Payment plugin to the Magento module system. omise-magento-2 Manual Install 02

  7. Then, execute the command, php bin/magento setup:upgrade to upgrade your Magento system (to install Omise-Magento plugin).

  8. Your installation is now completed. Check the First Time Setup to continue setting up your Omise account to Magento store.

First Time Setup

After installing, you can configure the module by:

  1. Log in to your Magento back-end with the administrator account.
  2. Go to Stores > Configuration > Sales > Payment Methods.

Settings is displayed under the Omise section.

omise-magento-2 Configuration

The table below is the settings for the module and the description for each setting.

Setting Description
Enable/Disable Enables or disables 'Omise Payment Module'
Sandbox If selected, all transactions will be performed in TEST mode and TEST keys will be used
Public key for test Your TEST public key can be found in your Dashboard.
Secret key for test Your TEST secret key can be found in your Dashboard.
Public key for live Your LIVE public key can be found in your Dashboard.
Secret key for live Your LIVE secret key can be found in your Dashboard.
Payment Action Set Authorize Only to only authorize a payment or Authorize and Capture to automatically capture after authroizing.
Title Title of Omise Payment gateway shown at checkout.
  • To enable the module, select the setting for Enable/Disable to Yes.
  • To enable sandbox mode, select the setting for Sandbox to Yes.

Note:

If the setting for Sandbox is set to Yes, the keys for TEST will be used. If the setting for Sandbox is set to No, the keys for LIVE will be used.