first commit

readme.md

@@ -0,0 +1,199 @@
+# Платіжний модуль Hutko PrestaShop
+
+Hutko – це платіжний сервіс, який рухає бізнес вперед. Запуск, набирання обертів, масштабування – ми подбаємо про вас усюди.
+
+Цей модуль інтегрує платіжний шлюз Hutko у ваш магазин PrestaShop, дозволяючи вашим клієнтам безпечно оплачувати свої замовлення через Hutko.
+
+## Зміст
+
+1. [Функції](#функції)
+
+2. [Встановлення](#встановлення)
+
+3. [Конфігурація](#конфігурація)
+
+4. [Використання](#використання)
+
+5. [Підтримка](#підтримка)
+
+## Функції
+
+* Безперешкодна інтеграція з платіжним шлюзом Hutko.
+
+* Безпечна обробка платежів.
+
+* Підтримка різних статусів платежів (Схвалено, Відхилено, Минув термін дії, Обробляється).
+
+* Автоматичне оновлення статусу замовлення в PrestaShop.
+
+* Надійна обробка зворотних викликів платежів для запобігання умовам гонки.
+
+## Встановлення
+
+Виконайте такі кроки, щоб встановити модуль Hutko у вашому магазині PrestaShop:
+
+1. **Завантажте модуль:** Отримайте останню версію модуля Hutko з офіційного джерела або з наданого вами пакета.
+
+2. **Завантажте в PrestaShop:**
+
+* Увійдіть до панелі адміністратора PrestaShop.
+
+* Перейдіть до **Модулі > Менеджер модулів**.
+
+* Натисніть кнопку «Завантажити модуль» (зазвичай розташована у верхньому правому куті).
+
+* Перетягніть файл модуля `.zip` в область завантаження або клацніть, щоб вибрати файл.
+
+3. **Встановіть модуль:**
+
+* Після завантаження PrestaShop автоматично виявить модуль.
+
+* Натисніть кнопку «Встановити» поруч із модулем «Hutko».
+
+* Дотримуйтесь будь-яких підказок на екрані.
+
+## Конфігурація
+
+Після успішної інсталяції необхідно налаштувати модуль, використовуючи дані вашого облікового запису Hutko:
+
+1. **Конфігурація модуля доступу:**
+
+* У панелі адміністратора PrestaShop перейдіть до **Модулі > Менеджер модулів**.
+
+* Знайдіть модуль "Hutko" та натисніть кнопку "Налаштувати".
+
+2. **Введіть необхідні облікові дані:**
+
+* **Ідентифікатор продавця:** Введіть свій унікальний ідентифікатор продавця, наданий Hutko. Це обов'язкове поле.
+
+* **Секретний ключ:** Введіть свій секретний ключ, наданий Hutko. Це обов'язкове поле, яке є критично важливим для безпечної перевірки підпису.
+
+* **Статус успішного замовлення:** (Необов'язково, якщо застосовується) Виберіть статус замовлення, який слід застосовувати до замовлень, успішно оплачених через Hutko.
+
+* **Показати логотип картки:** (Необов'язково) Увімкніть або вимкніть відображення логотипів картки на сторінці вибору способу оплати.
+
+3. **Зберегти зміни:** Натисніть кнопку "Зберегти", щоб застосувати налаштування конфігурації.
+
+**Важливо:** Без правильного налаштування **Ідентифікатора продавця** та **Секретного ключа** модуль не працюватиме належним чином і не відображатиметься як варіант оплати під час оформлення замовлення.
+
+## Використання
+
+Після налаштування варіант оплати Hutko автоматично з’явиться на сторінці оформлення замовлення для клієнтів.
+
+1. Клієнти вибирають «Оплатити через Hutko» на кроці оплати.
+
+2. Їх буде перенаправлено на сторінку оплати Hutko для завершення транзакції.
+
+3. Після успішної оплати клієнта буде перенаправлено назад на сторінку підтвердження замовлення вашого магазину PrestaShop, і статус замовлення буде оновлено відповідно.
+
+4. У разі невдалої оплати клієнта буде перенаправлено назад на сторінку замовлення з відповідним повідомленням про помилку.
+
+## Підтримка
+
+Якщо у вас виникнуть проблеми або виникнуть запитання щодо модуля Hutko PrestaShop, будь ласка, зверніться до наступного:
+
+* **Документація Hutko:** Зверніться до офіційного API та документації інтеграції Hutko для отримання детальної інформації.
+
+* **Форуми PrestaShop:** Шукайте або залишайте своє запитання на офіційних форумах PrestaShop.
+
+* **Зв’язатися з розробником:** Для отримання безпосередньої підтримки ви можете звернутися до автора модуля `panariga`.
+
+# Hutko PrestaShop Payment Module
+
+Hutko is a payment service that drives businesses forward. Launch, gain momentum, scale – we've got you covered everywhere.
+
+This module integrates the Hutko payment gateway into your PrestaShop store, allowing your customers to pay for their orders securely through Hutko.
+
+## Table of Contents
+
+1. [Features](#features)
+
+2. [Installation](#installation)
+
+3. [Configuration](#configuration)
+
+4. [Usage](#usage)
+
+5. [Support](#support)
+
+## Features
+
+* Seamless integration with the Hutko payment gateway.
+
+* Secure payment processing.
+
+* Support for various payment statuses (Approved, Declined, Expired, Processing).
+
+* Automatic order status updates in PrestaShop.
+
+* Robust handling of payment callbacks to prevent race conditions.
+
+## Installation
+
+Follow these steps to install the Hutko module on your PrestaShop store:
+
+1. **Download the Module:** Obtain the latest version of the Hutko module from the official source or your provided package.
+
+2. **Upload to PrestaShop:**
+
+   * Log in to your PrestaShop admin panel.
+
+   * Navigate to **Modules > Module Manager**.
+
+   * Click on the "Upload a module" button (usually located in the top right corner).
+
+   * Drag and drop the module's `.zip` file into the upload area, or click to select the file.
+
+3. **Install the Module:**
+
+   * Once uploaded, PrestaShop will automatically detect the module.
+
+   * Click on the "Install" button next to the "Hutko" module.
+
+   * Follow any on-screen prompts.
+
+## Configuration
+
+After successful installation, you must configure the module with your Hutko account details:
+
+1. **Access Module Configuration:**
+
+   * In your PrestaShop admin panel, go to **Modules > Module Manager**.
+
+   * Find the "Hutko" module and click on the "Configure" button.
+
+2. **Enter Required Credentials:**
+
+   * **Merchant ID:** Enter your unique Merchant ID provided by Hutko. This is a mandatory field.
+
+   * **Secret Key:** Enter your Secret Key provided by Hutko. This is a mandatory field and is crucial for secure signature validation.
+
+   * **Success Order Status:** (Optional, if applicable) Select the order status that should be applied to orders successfully paid via Hutko.
+
+   * **Show Cards Logo:** (Optional) Enable or disable the display of card logos on the payment selection page.
+
+3. **Save Changes:** Click the "Save" button to apply your configuration settings.
+
+**Important:** Without setting the correct **Merchant ID** and **Secret Key**, the module will not function correctly and will not appear as a payment option during checkout.
+
+## Usage
+
+Once configured, the Hutko payment option will automatically appear on your checkout page for customers.
+
+1. Customers select "Pay via Hutko" on the payment step of the checkout.
+
+2. They are redirected to the Hutko payment page to complete their transaction.
+
+3. Upon successful payment, the customer is redirected back to your PrestaShop store's order confirmation page, and the order status is updated accordingly.
+
+4. In case of payment failure, the customer will be redirected back to the order page with an appropriate error message.
+
+## Support
+
+If you encounter any issues or have questions regarding the Hutko PrestaShop module, please refer to the following:
+
+* **Hutko Documentation:** Consult the official Hutko API and integration documentation for detailed information.
+
+* **PrestaShop Forums:** Search or post your question on the official PrestaShop forums.
+
+* **Contact Developer:** For direct support, you can contact the module author `panariga`.