WooCommerce

Omise WooCommerce is the official payment extension which provides support for Omise payments for store builders working on the WooCommerce platform.

Supported versions

WooCommerce version 3.3.4 and above (tested to version 3.6.4).

The extension doesn't work on your version?

We want to be supporting as many versions of WooCommerce as we can. If the version you are currently working on has not been tested on, you can test it out, and if you face any issues please let us know on GitHub's issue channel by following the "Reporting an issue Guideline".

Getting started

Installation instructions

To install the Omise-WooCommerce plugin, you can either manually download the plugin from this repository and install it or download it via the WordPress Plugin Store.

Manual installation

  1. Download and extract the zip file from Omise-WooCommerce to your local machine. screen shot 2560-07-26 at 12 36 43 pm
  2. Copy all files from step 1 to the WordPress plugin folder, your-wordpress-dir/wp-content/plugins/omise-woocommerce-3.4.
  3. Rename the omise-woocommerce-3.4 folder to omise screen shot 2560-07-26 at 12 36 43 pm
  4. Once done, you will find Omise Payment Gateway on the Installed Plugins page. Click activate to activate the plugin. omise-woocommerce-plugin-activate

You have now completed the installation process.

Next, check First-time setup to continue setting up your Omise account with your WooCommerce store.

First-time setup

Connect your store with your Omise account

Omise-WooCommerce plugin - setting page Once you have installed the plugin, next up is to connect your store with your Omise account, and enable your preferred payment methods.This will enable your customers to make payments on your store through Omise.

  1. Log in to the WordPress admin page.
  2. From the sidebar, go to Omise > Settings.
  3. Here, you are going to set your Public key and Secret key (these keys can be found in your Omise Dashboard).
  4. If you would like to test out the integration before going live and receiving actual payments from your customers, make sure that Test mode is checked, and that you are using the Public key for test and Secret key for test.
  5. Click 'Save Settings'.

Enabling payment methods

The plugin currently supports 3 payment opitions; Alipay, Credit / Debit Card, and Internet Banking.

Note that Alipay and Internet Banking are only available for merchants with a Thai-registered Omise account.

  1. On the Omise Settings page, under Payment Methods, you will find the 3 available payment methods shown on the list.
  2. Click config at the table on a payment method that you would like to accept payment with.
  3. The screenshot below shows the configuration page for Credit/Debit card payments. The configuration page varies depending on the the payment method selected. omise-woocommerce-creditcard-setting-page
  4. At the configuration page, check the Enable/Disable field.
  5. You may also choose to change or update any other option on this page (optional).
  6. Click 'Save changes'. Once done, the payment methods you selected will be available at your checkout page. screen shot 2560-07-26 at 8 13 55 pm

What's Next?

To learn more on how to create a charge, issure a refund, or any other details about the plugin please check the Omise-WooCommerce's Wiki.

Contributing

We look forward to hearing from you, and are willing to review your changes. Please follow the instructions in the links below if you would like to submit changes and/or issues.

Submitting changes

You're all welcome to submit a pull request. Please consider the pull request template and fill out the form whenever you submit a new pull request.

Learn more about submitting a pull request here: https://help.github.com/articles/about-pull-requests

Submittng an issue

Please submit your issues through GitHub's issue channel.

You can learn more about submitting an issue here: https://guides.github.com/features/issues

License

Omise-WooCommerce is open-sourced software released under the MIT License.