-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
0 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,3 @@ | ||
| Instamojo-OpenCart for OpenCart versions 2.x | ||
| ==== | ||
| ---- | ||
| This module allows us to use [Instamojo](https://www.instamojo.com) as Payment Gateway in OpenCart 2.x | ||
| (**Note:** If you're using OpenCart version 1.5.x then use our other plugin: https://github.com/instamojo/Instamojo-OpenCart-1.5/) | ||
| ###Installation | ||
| --- | ||
| - Download the [zip file](https://github.com/instamojo/Instamojo-OpenCart-2.0/archive/master.zip) and paste the content of **upload** folder into your sites main directory, this is **public_html** is most cases. Note that inside **public_html** you will already have folders named **admin** and **catalog**, so you are supposed to merge the **admin** and **catalog** from our module to those folders. | ||
|
|
||
| - Now go the admin backend and there go to **Extensions -> Payments**: | ||
|
|
||
|  | ||
|
|
||
| This page will display all the Payment modules present along with **Instamojo Payment Method**. | ||
|
|
||
|  | ||
|
|
||
| Click on the button with **+** to install **Instamojo Payment Method**. After installation click on the edit button: | ||
|
|
||
|  | ||
|
|
||
| Click on **Edit** to configure the module. | ||
|
|
||
| Now you will see a form like this: | ||
|
|
||
|  | ||
|
|
||
| --- | ||
| I will explain **`Order Status`**, **`Checkout Label`** and **`Status`** here and rest of the fields are explained in next sections: | ||
|
|
||
| - **Order Status**: This is the order of the status that you would like to set after a **successful** payment. | ||
| - **Checkout Label**: This is the label users will see during checkout, its default value is **"Pay using Instamojo"**. You can change it to somethint more generic like **"Pay using Credit/Debit Card or Online Banking"**. | ||
| - **Status**: This is the current status of the module. To use Instamojo during checkout make sure to change it to **enabled**. | ||
|
|
||
| ### Creating a Product | ||
| ---- | ||
| In this section we will learn how to create a product along with how to get the required values for `Payment Link` and `Custom Field`. | ||
|
|
||
| - Create a product by clicking on **Add a Product** on your Instamojo dashboard and choose the category **Other**. | ||
|
|
||
| Set the price to Rs. 10 and enable **"Pay what you want"**. Under **Title** and **Description**, you may enter something that describes your business and the nature of the products being sold. | ||
|
|
||
| Under **Advanced settings** of the same product there's a field **Custom Redirection URL**. Here if your website's url is **http://www.example.com** then use **http://www.example.com/index.php?route=payment/instamojo/callback** as **Custom Redirection URL**. | ||
|
|
||
|  | ||
|
|
||
| Click on **Add Product to Store** to save the product. | ||
|
|
||
| - Copy the product URL and paste this in **Payment Link** field. URL's format is usually: **https://www.instamojo.com/username/slug/**. | ||
| - On the product page go to **More options** and click on **Custom Fields**. Create a custom field called **Order ID** and mark it as **required**. Click on **Add Custom Field** to save this custom field. | ||
|
|
||
|  | ||
|
|
||
| After the custom field has been created **Existing Custom Fields** section will appear. Copy the name shown under **Field ID** column, its format is **Field_xxxx**, where **xxxx** are some numbers(Note that this is case sensitive!). In this example the value is **Field_11828**. | ||
|
|
||
|  | ||
|
|
||
| Enter this value in the **Custom field** field of the Instamojo module configuration page in OpenCart. | ||
|
|
||
| ### Auth | ||
| --- | ||
| In this section we will learn how to get the values of fields `API Key`, `Auth token` and `Private salt`. | ||
|
|
||
| Go the [Instamojo developers](https://www.instamojo.com/developers/) page, if your are not logged in already then login first and then you'll see the value of `API Key`, `Auth token`, `Private salt` there on the bottom left side of the page. | ||
|
|
||
| Simply copy and paste their values in the configuration form in their respective fields. | ||
|
|
||
| --- | ||
|
|
||
| Now your form will look something like this: | ||
|
|
||
|  | ||
|
|
||
| Now simply click on **save**(button with floppy icon) to save these setting and now the **Pay using DB/CC or Online banking**<sup>*</sup> option will show up on the checkout page. | ||
|
|
||
|  | ||
|
|
||
| ### Logs | ||
| --- | ||
|
|
||
| This module will everything to a file named **imojo.log** under **system/logs**. Share it with us if you're facing some issue while making a transaction using this module. Our support email id is: [email protected] | ||
|
|
||
| --- | ||
| <sub>`*` This may be different for your **Checkout Label** is different.</sub> | ||
|
|
||
| ### Support | ||
| --- | ||
|
|
||
| If you're facing some issue with plugin integration then open an ticket at http://support.instamojo.com/. Please do include a **screenshot of the settings** you've done for the plugin in your admin backend as well as the **URL of the Instamojo payment link** you're using with the plugin. | ||
| ======= | ||
|
|
||
|
|
||
| # Instamojo Opencart 2.X Payment Gateway Plugin | ||
|
|
||
| Tested on OpenCart 2.0.3.1, 2.1.0.2 and 2.2.0.2 | ||
|
|
||