Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kohortpay/module-magento
Official KohortPay Adobe Commerce (Magento) module
https://github.com/kohortpay/module-magento
adobe-commerce magento2 magento2-module module payment-module
Last synced: about 2 months ago
JSON representation
Official KohortPay Adobe Commerce (Magento) module
- Host: GitHub
- URL: https://github.com/kohortpay/module-magento
- Owner: kohortpay
- License: mit
- Created: 2023-12-21T11:47:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T14:23:48.000Z (9 months ago)
- Last Synced: 2024-04-02T15:29:37.606Z (9 months ago)
- Topics: adobe-commerce, magento2, magento2-module, module, payment-module
- Language: PHP
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Official KohortPay Magento module
This module adds a new payment method to Magento: `KohortPay`, which allows you to lower your acquisition costs by turning your customers into your brands advocates. They will have the opportunity to invite all their friends to buy more on your store in exchange for cashback.
## Table of content
- [Official KohortPay Magento module](#official-kohortpay-magento-module)
- [Table of content](#table-of-content)
- [What is KohortPay](#what-is-kohortpay)
- [Description](#description)
- [Benefits](#benefits)
- [Module overview](#module-overview)
- [Version](#version)
- [Licence](#licence)
- [Compabilities and Restrictions](#compabilities-and-restrictions)
- [Features](#features)
- [Installation](#installation)
- [Using ZIP](#using-zip)
- [Using Magento marketplace](#using-magento-marketplace)
- [Using Symfony CLI](#using-symfony-cli)
- [Using Composer](#using-composer)
- [Configuration](#configuration)
- [Prerequisites](#prerequisites)
- [Activation](#activation)
- [Merchant API Key](#merchant-api-key)
- [Minimum amount](#minimum-amount)
- [Demo](#demo)
- [Testing](#testing)
- [Requirements](#requirements)
- [Starting Magento](#starting-magento)
- [Testing the module](#testing-the-module)
- [Stopping Magento](#stopping-magento)
- [Need help](#need-help)
- [Documentation](#documentation)
- [Feedback](#feedback)
- [Support](#support)
## What is KohortPay
### Description
KohortPay lets your customers pay, refer and save on every purchase. Cut your customer acquisition costs in half while offering your customers a social and fun brand experience. And just like that, your checkout becomes so koool.
### Benefits
- **No setup costs**: integrate KohortPay on your site and increase customer satisfaction in 10 minutes - ready, set, GO.
- **Lower your acquisition costs**: drive high-quality customer acquisition at half the cost of existing overpriced customer acquisition channels.
- **Pay for performance**: no commitments. You only pay for results. Start and stop in 1 click.
- **Brand reinforcement**: generate content from customers and harness the power of word-of-mouth recommendations. Personalize KohortPay to look and feel like your brand. Configure the experience to overcome your challenges and meet your objectives.
## Module overview
### Version
Current version is 1.1.0. See all [releases here](https://github.com/kohortpay/module-magento/releases).
### Licence
The module and this repository is under MIT License.
### Compabilities and Restrictions
- Only FR and EN languages available.
- Only EUR currency available.
- Works and has been tested with Magento 2.4 (should work from Magento 2.0 but not tested, use at your own risk).
### Features
- Add a new payment method that you customer will love (Pay less, together)
- Redirect to an awesome and customized payment page (using you customer cart details).
- Enable/disable the module by a simple switch through the settings.
- Possibility to set minimun amount, under which the payment is disabled.
- Easy way to switch live/test mode by filling you API secret key (sk or sk_test).
- Handle API errors (with more details if Magento is in debug mode).
## Installation
### Using ZIP
1. Upload KohortPay folder in ROOT_MAGENTO_DIRECTORY/app/code
2. Run the following shell commands:
```
bin/magento module:enable Kohortpay_Payment
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```
4. After installation is done, you can configure it ([see instructions below](#configuration))
### Using Magento marketplace
Coming soon...
### Using Symfony CLI
Coming soon...
### Using Composer
Coming soon...
## Configuration
### Prerequisites
- You should have a KohortPay account. If it's not the case, you can [register here](https://dashboard.kohortpay.com/sign-up).
- You should have installed the module on your Magento instance and have access to its settings page.
### Activation
You can display or hide the KohortPay payment method from you checkout page using this configuration (enabled/disabled).
### Merchant API Key
Found in KohortPay Dashboard > Developer settings > API Keys.
Start with sk_ or sk_test (for test mode).
### Minimum amount
You can define here the total order minimum amount to display the KohortPay payment method (minimum 30€).
## Demo
You can access a live demo of the KohortPay module here (Magento 2.4):
- Front-Office : [https://magento-demo.kohortpay.com](https://magento-demo.kohortpay.com)
- Back-Office : [https://magento-demo.kohortpay.com/admin](https://magento-demo.kohortpay.com/admin)
- Login : demo
- Password : demo123
## Testing
If you want to test the KohortPay module on a fresh Magento installation, please read the following instruction.
The stack is based on Bitnami Docker image.
### Requirements
- Git ([Install instruction](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git))
- Docker desktop:
- [Mac install instruction](https://docs.docker.com/desktop/install/mac-install/)
- [Windows install instruction](https://docs.docker.com/desktop/install/windows-install/)
- Docker Compose: Already included in Docker Desktop.
### Starting Magento
1. Start your Docker desktop application
2. Clone the repository and go inside the directory:
```
git clone [email protected]:kohortpay/module-magento.git
cd module-magento
```
3. Start the docker stack:
```
docker-compose up -d --build
```
4. Wait for container to be up (~1 minute), then visit http://localhost/
5. Your Magento is UP. Enjoy!
### Testing the module
1. Go to Magento admin: http://localhost/admin/
2. Log in with these credentials:
- Login: user
- Password: bitnami1
3. Install the module ([see instruction above](#installation))
4. Configure the module ([see instructions above](#configuration))
5. Go back to the frontend (http://localhost/) and proceed to the checkout with enough products in your cart (to reach minimum amount defined in settings).
6. At the Step 4, select KohortPay as a payment method and place the order. You should be redirected to KohortPay payment page. Enjoy!
### Stopping Magento
When your tests are over, you can stop and destroy everything with the following command:
```
docker-compose down --volumes
```
## Need help
### Documentation
If you have any questions, do not hesitate to check our documentations:
- [Product Docs](https://docs.kohortpay.com/)
- [API & SDK Reference](https://api-docs.kohortpay.com/)
- [Help Center](https://help.kohortpay.com/fr)
### Feedback
If you have any idea or suggestion to improve our solution or the module, you can send an email to [email protected]. You can also check our [roadmap here](https://roadmap.kohortpay.com/tabs/1-under-consideration).
### Support
If you need help, please contact our support team by sending an email to [email protected].
**NB**: We don't provide any SLA on our support response time (best effort).