Skip to main content
Version: Current

Magento

Topics covered on this page

Accept payments through Omise on your Magento-based online store. No programming is required.

Supported Versions​

Supports Magento 2.1.18 – 2.4.5.

Please use at least the minimum recommended version of the omise-magento library.  For
more information, see Library Updates Required.

Can't find your version of Magento? Please contact support.

Supported Payment Methods​

  • Alipay (Online)
  • Alipay CN
  • Alipay HK
  • Bill Payment
  • Boost
  • Credit and Debit Cards
  • DANA
  • DuitNow Online Banking/Wallets
  • DuitNow QR
  • FPX
  • GCash
  • Google Pay
  • GrabPay
  • Installments
  • Internet Banking
  • Kakao Pay
  • Konbini, Pay-easy, and Online Banking
  • Maybank QR
  • Krungsri (KMA)
  • Bangkok Bank (Bualuang mBanking)
  • KBank (K PLUS)
  • OCBC Digital
  • OCBC PAO
  • Pay with Points
  • PayNow
  • PayPay
  • PromptPay
  • Rabbit Line pay
  • ShopeePay
  • Touch 'n Go
  • TrueMoney Wallet

Do you need a payment method that is not currently supported? Please contact support.

Installation​

Use Composer to install.

Run the following command in the same directory as your Magento installation:

composer require omise/omise-magento

If you are installing the module to an existing Magento installation, you may need to run the following commands after running composer:

php bin/magento module:enable Omise_Payment --clear-static-content
php bin/magento setup:upgrade
php bin/magento setup:di:compile

Configuration​

Connect your Omise account and enable your preferred payment methods. This enables your customers to make payments on your store through Omise.

In your Magento admin interface:

  1. Go to Stores > Configuration > Sales > Payment Methods.
  2. Configuration options are displayed under the Omise section.
  3. Add your test and live keys and enable the module

configuration

Note: If the setting for Sandbox is set to Yes, your test keys will be used. If the setting for Sandbox is set to No, your live keys for LIVE will be used.

Enabling 3DS​

If you would like to process 3DS (also known as 3-D Secure) charges, please contact support. to enable 3DS on your account.

If the Omise team has enabled 3DS in the merchant's account, but the store has not activated the plugin yet, you may encounter difficulties receiving payment. You will receive a notification saying, “3d secure is requested, but return URI is not set”.

Upgrading to the new secure form​

To upgrade to the new secure form on Magento, use the following instructions:

Use composer to upgrade Magento.

Run the following command in the same directory as your existing Magento installation.

composer update omise/omise-magento

Then run the following commands to enable Omise:

php bin/magento module:enable Omise_Payment --clear-static-content
php bin/magento setup:upgrade
php bin/magento setup:di:compile

Enabling the secure form for payments​

Important: Any customizations that you made to the earlier card
 payment form are NOT retained when using the new secure form. You
  must redo the customizations for the secure form.
  1. Select Payment Settings in the Settings screen.
  2. Click Configure for Omise.
  3. Expand Enable Credit Card Payment settings.
  4. Set Secure Form to Yes.
  5. (Optional) Select the theme (light or dark) for the secure form.
    By default, the theme is set to Dark.

To customize the form, click the link as highlighted.

Enable Credit Card Payment Settings

Then, customize the form as desired.

Enable Credit Card Payment Settings

Click Preview to preview the form.

Enable Credit Card Payment Settings

Click Save data to save the customized form.

  1. Click Save Config.
Clear your browser's cache before using the new form.

Once set to Yes, the secure form is shown to customers who pay using card payments.

The secure form will soon be the default.
We encourage all merchants to use it and provide feedback.

Customization​

This plugin is open source.
To see the source code and details on how to contribute changes, visit its repository on GitHub.
Pull requests are welcome.

Support​

If you're having issues with this plugin, please contact support.