Magento 2

Requirements

To integrate Magento 2 with Omise API, your Omise Public key and Secret key are required for configuration.

If you do not have an Omise account, you can easily register for one. If you already have an Omise account, you can find your keys here.

Magento 2 Version Compatibility

  • Minimum version is 2.1.2.

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

  1. Log in to your Magento server by using Terminal program, then change the current directory to your Magento root directory.
  2. Execute command composer require omise/omise-php:2.6.0 to install Omise-PHP library.
  3. Execute php bin/magento module:enable Omise_Payment --clear-static-content to enable the module.

omise-magento-2 Manual Install 02

  1. At the current directory, execute the command, php bin/magento setup:upgrade to upgrade your Magento system.
  2. Your installation is now completed.

Configuration

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.

Checking out

After completing configuration, Omise payment will be displayed at the payment method page and the header will be the value defined in the setting for Title.

omise-magento-2 Checkout

Your customers can now make payments through Omise.