Type
library
library
None
None
None
None
None
None
None
Omise Magento is the official payment extension which provides support for Omise payment gateway for store builders working on the Magento platform.
Our aim is to support as many versions of Magento as we can.
Here's the list of versions we tested on: - Magento (CE) 1.9.3.2 on PHP 5.6.28. - Magento (CE) 1.9.3.1 on PHP 5.6.28.
To report problems for the version you're using, feel free to submit the issue through GitHub's issue channel by following the Reporting the issue Guideline.
Can't find the version you're looking for?
Submit your requirement as an issue to https://github.com/omise/omise-magento/issues
The steps below shows how to install the module manually.
local machine
(or directly to your server)./src
directory and copy all files into your Magento Project, at a root directory.Omise
menu on the top of your admin page.Omise
menu, try clear the system caches by going to System > Cache Management
. Then, Flush Magento Cache
.<p align="center"><a alt="omise-magento-install-manual-04" href='https://cloud.githubusercontent.com/assets/2154669/23206320/c539ac9e-f91f-11e6-803d-7eb7a29bf8e2.png'><img title="omise-magento-install-manual-04" src='https://cloud.githubusercontent.com/assets/2154669/23206320/c539ac9e-f91f-11e6-803d-7eb7a29bf8e2.png' /></a></p>
5. Next, check the First Time Setup to continue setting up your Omise account to Magento store.
In order to make a charge with Omise, you have to link the store to your Omise account by using your credentials (public and secret keys):
Omise > Keys Setting
. You will be redirected to the Omise module setting page.Omise Keys
. Anyway if you want to test Omise service integration, you can enable test mode by clicking Enable test mode
. Your Magento will then process orders with your test keys.In order to enable Omise Payment Gateway in the checkout page, you have to enable the module from Magento's configuration page, at the payment method section.
Omise > Module Setting
. You will be redirected to the Magento's payment method configuration page.Omise Payment Gateway
section with 2 payment methods, Credit Card and Internet Banking.Enabled
to Yes
to activate the payment method and save the config.In some business models you may need to capture the charge at a later time.
For example, when you can capture the charge only when you have the product in stock or before shipping. In that case, during checkout Omise will only authorize and hold the charge.
You can hold a charge for as long as permitted by the issuing bank. This delay may vary between cards from 1 to 30 days depending on each card.
The 2 available options for Payment Action are Authorize only
or Authorize and Capture
.
And, other option is New order status, which can be set to Pending
or Processing
status. Your order status after checkout process will be set depends on the option here.
By default, the checkout process of Magento has many steps and it have been displayed step by step. This default checkout process can be adjusted by the merchant.
One of the adjustment is the merchant will find and install an extension to reduce the checkout steps or change the display of checkout process to be in one page.
There are so many third-party extensions that delivered this feature. But most of those extensions are not compatible with omise-magento. Because omise-magento has a secure step at the client side (the JavaScript at the web browser of the payer) to create a token to be the representative of the card information of the payer. That token is used to be the representative between merchant server and Omise API for process the payment.
Most of extensions have no any procedure to trigger this step of omise-magento. So the merchant who use the OPC need to modify their extension.
Note: With the invalid modification, it may adversely affect to the normal process. So, please do the backup before the modification.
The steps below are an example of modifying the OPC extension, IWD One Page Checkout free version, to work with omise-magento.
Add a HTML element, hidden, to be the referece within the checkout page and across the extension
<input type="hidden" id="omise-public-key" value="<?php echo $this->getOmiseKeys('public_key'); ?>" />
Insert the steps of create Omise token to the checkout process of the OPC extionsion
if (paymentMethodForm.validate()) {
IWD.OPC.savePayment();
} else {
// ...
}
if (paymentMethodForm.validate()) {
// Begin of the modification
// Check a condition to create the Omise token only the payment method is omise_gateway
if (payment.currentMethod == "omise_gateway") {
// Use an external script, omise.js, by using the Omise utility function
getScript("https://cdn.omise.co/omise.min.js.gz", function() {
// Set the public key
Omise.setPublicKey(document.getElementById("omise-public-key").value);
// Create the card information for submit to create Omise token
var card = {
"name" : document.getElementById("omise_gateway_cc_name").value,
"number" : document.getElementById("omise_gateway_cc_number").value,
"expiration_month" : document.getElementById("omise_gateway_expiration").value,
"expiration_year" : document.getElementById("omise_gateway_expiration_yr").value,
"security_code" : document.getElementById("omise_gateway_cc_cid").value
};
// Create Omise token
Omise.createToken("card", card, function(statusCode, response) {
if (statusCode == 200) {
// Handle the success case
// Set the token value from the response to the HTML element, omise_gateway_token, for submit the checkout process
document.getElementById("omise_gateway_token").value = response.id;
// Perform the checkout process of the extension normally
IWD.OPC.savePayment();
} else {
// Handle the error case
// For an example, display the popup with the error message
alert(response.message);
}
});
});
} else {
// Remain the same process of the extension before modification
IWD.OPC.savePayment();
}
// End of the modification
} else {
// ...
}
Make sure to store the modified files to your server. The checkout process with omise-magento should be work successfully.
Thanks for your interest in contributing to Omise Magento. We're looking forward to hearing your thoughts and willing to review your changes.
The following subjects are instructions for contributors who consider to submit changes and/or issues.
You're all welcome to submit a pull request. Please consider the pull request template and fill the form when you submit a new pull request.
Learn more about submitting pull request here: https://help.github.com/articles/about-pull-requests
Submit the issue through GitHub's issue channel.
Learn more about submitting an issue here: https://guides.github.com/features/issues
Omise-Magento is open-sourced software released under the MIT License.