VibeFox Autopay for PrestaShop — Допомога

Вимоги

PrestaShop: від 8.0 до 9.x.

PHP: 8.0 або новіша версія. Модуль не встановлюється на старіших версіях PHP.

Служба Autopay: потрібні Service ID і Shared key (хеш-ключ) вашої служби Autopay. Вони відображаються в торговельному порталі Autopay: portal.autopay.eu для робочого режиму, testportal.autopay.eu для тестування. Тестові служби мають власні Service ID і Shared key; попросіть Autopay відкрити одну. Хеш-функція служби має бути SHA-256.

Валюта: валюта кошика має бути PLN, EUR, GBP, USD або CZK і прийматися вашою службою Autopay.

Доступний магазин: Autopay має мати змогу надсилати сповіщення вашому магазину, тож магазин має бути доступним з інтернету без базової автентифікації та без брандмауера, який блокує POST-запити. Режим обслуговування та обмеження за країнами вашого магазину сповіщення не блокують.

Ліцензійний ключ VibeFox: купується на vibefox.net. Один ключ працює на одному домені.

Встановлення

1. У back office перейдіть до Modules > Module Manager і натисніть Upload a module. Оберіть ZIP-файл модуля.

2. Коли завантаження завершиться, натисніть Configure або пізніше знайдіть VibeFox Autopay Payment у списку модулів і натисніть Configure.

3. Введіть ліцензійний ключ VibeFox у поле License key у блоці ліцензії вгорі сторінки Configure і натисніть Activate (див. Ліцензійний ключ).

4. Введіть Service ID і Shared key (тестові та робочі) і оберіть валюти вашої служби.

5. У порталі Autopay задайте для вашої служби URL ITN, URL повернення і хеш-функцію SHA-256 (див. Налаштування).

6. Увімкніть Enable/Disable і натисніть Save. Створіть тестове замовлення в тестовому режимі, потім вимкніть Test mode для реальних платежів.

Під час встановлення модуль створює статус замовлення Autopay payment on hold. PrestaShop вмикає новий платіжний модуль для всіх валют, країн і груп клієнтів. Обмежити їх можна в Payment > Preferences.

Налаштування

Усі параметри розташовані на сторінці модуля: Modules > Module Manager > VibeFox Autopay Payment > Configure. Кожен розділ має власну кнопку Save, яка зберігає всю сторінку. Над полями сторінка попереджає, якщо Service ID або Shared key обраного середовища порожні, і якщо валюта за замовчуванням магазину не вибрана в Currencies. В обох випадках спосіб оплати приховується на оформленні замовлення (для валюти, яка не вибрана).

Autopay

Enable/Disable: Enable Autopay payment gateway вмикає або вимикає спосіб оплати. За замовчуванням: вимкнено.

Title: назва способу оплати, яку бачить покупець на оформленні замовлення. Вона також зберігається в замовленні як назва способу оплати. За замовчуванням: Autopay. Обов'язково.

Description: текст під способом оплати на оформленні замовлення. За замовчуванням: Pay online by bank transfer, BLIK or card. You will be redirected to the secure Autopay payment page.

Служба Autopay

Service ID і Shared key відображаються в торговельному порталі Autopay (portal.autopay.eu або testportal.autopay.eu, посилання в цьому розділі).

Test mode: використовує тестове середовище Autopay (testpay.autopay.eu) і тестові дані нижче. За замовчуванням: увімкнено. Вимкніть, щоб приймати реальні платежі на pay.autopay.eu з робочими даними.

Service ID (production): числовий ідентифікатор служби з portal.autopay.eu.

Shared key (production): хеш-ключ робочої служби. Тримайте його в таємниці.

Service ID (test): числовий ідентифікатор тестової служби з testportal.autopay.eu.

Shared key (test): хеш-ключ тестової служби.

Під час збереження Service ID із символами, відмінними від літер, цифр, дефісів або підкреслень, відхиляється з помилкою, і нічого не зберігається. Збережені Shared key більше ніколи не відображаються. Поле залишається порожнім і показує Saved — leave empty to keep it. Вводьте нове значення, лише якщо хочете його змінити.

Clear saved keys: позначте ключ і натисніть Save, щоб видалити його. Порожнє поле зберігає збережене значення.

Currencies: валюти, які приймає ваша служба Autopay: PLN, EUR, GBP, USD, CZK. Autopay зазвичай відкриває окрему службу для кожної валюти. Спосіб оплати пропонується лише тоді, коли валюта кошика вибрана тут. За замовчуванням: PLN.

Сповіщення про платежі (ITN) і адреса повернення

Введіть ці адреси в порталі Autopay для вашої служби — для робочого і тестового режиму. Точні адреси відображаються в полі Addresses цього розділу. З «зручними» URL вони виглядають так, можливо, з кодом мови, наприклад /en/:

Копіюйте адреси точно так, як їх показують налаштування. Без URL ITN замовлення ніколи не створюються, оскільки PrestaShop створює замовлення лише тоді, коли Autopay підтвердить платіж. Кожен ITN перевіряється за хешем SHA-256, сформованим з Shared key служби, вказаної в сповіщенні. Сповіщення без коректного хешу або з невідомим Service ID відхиляються. Сповіщення застосовується до кошика, лише якщо його платіж було розпочато з тією самою службою Autopay, тож тестове сповіщення ніколи не підтверджує робочий платіж. Сповіщення про платежі, розпочаті до перемикання Test mode, як і раніше перевіряються правильним ключем, доки обидва набори даних збережені.

Модуль обробляє в ITN такі статуси платежу:

Додатково

Logging: записує події платежів у logs/wc_ap_debug.log.php у папці модуля. Файл не можна відкрити з веб. Ключі та дані покупців ніколи не записуються в журнал. За замовчуванням: вимкнено. Поки вимкнено, нічого не записується, зокрема помилки.

Log: показує розмір і останні записи журналу. Натисніть Clear log, щоб очистити його.

Оформлення замовлення

На етапі оплати покупець обирає спосіб оплати (за замовчуванням Autopay) з його описом і підтверджує вибір. Наступна сторінка показує Thank you. You are being redirected to Autopay to complete the payment. Your order is created as soon as Autopay confirms it. і надсилає покупця на платіжну сторінку Autopay. Якщо покупець повертається кнопкою «Назад» браузера, сторінка показує кнопку Pay with Autopay замість повторного перенаправлення. На цьому етапі замовлення ще не існує.

Модуль передає суму кошика у валюті кошика, номер кошика як номер замовлення, опис (Cart і номер) та e-mail покупця. На сторінці Autopay покупець обирає спосіб оплати і платить.

Замовлення позначається оплаченим лише після того, як Autopay підтвердить його підписаним ITN, а сума і валюта збігаються з кошиком. Тоді замовлення створюється, і покупець отримує стандартні листи PrestaShop про замовлення. Після оплати покупець повертається до вашого магазину. Адреса повернення підписана, але ніколи не створює і не змінює замовлення. Якщо замовлення вже існує, покупець бачить стандартну сторінку підтвердження замовлення. Якщо ITN ще не надійшов, сторінка Payment confirmation показує Thank you. Your payment is being confirmed by Autopay — your order will be created as soon as Autopay confirms it, and you will receive an e-mail. з кнопками Check again і Back to checkout.

Якщо Autopay повідомив про невдалий платіж, покупець повертається до оформлення замовлення з повідомленням The payment was not completed. You can try again or choose another payment method. Кошик зберігається. Якщо платіж не вдалося розпочати, покупець залишається на оформленні замовлення з коротким повідомленням, наприклад Autopay payments are not configured. Please choose another payment method or contact the store. або про те, що Autopay не може приймати платежі в цій валюті.

Модуль не здійснює повернення коштів з PrestaShop, не підтримує підписки чи регулярні платежі, не зберігає картки, не має поля для коду BLIK чи форми карток на сторінці оформлення замовлення, не дає вибрати банк або платіжний канал на сторінці оформлення замовлення і використовує один Service ID для кожного середовища.

Замовлення

Статуси замовлень

No order yet: покупця надіслали на Autopay, і він не оплатив, платіж не вдався або Autopay ще не підтвердив платіж. Існує лише кошик.

Payment accepted: Autopay підтвердив платіж, і сума та валюта збігаються. Платіж записується з ID транзакції Autopay (remoteID) як ID транзакції, а примітка показує суму, транзакцію Autopay і дату платежу.

Autopay payment on hold: Autopay повідомив суму або валюту, що відрізняються від суми кошика (наприклад, кошик змінили після початку платежу). Замовлення не позначається оплаченим. Перевірте транзакцію в порталі Autopay і вручну завершіть її або поверніть кошти. Пізніше коректне сповіщення для цього замовлення позначає його оплаченим. Той самий статус використовується, коли надходить платіж за скасованим замовленням: платіж записується, а примітка просить перевірити запаси й виконати замовлення або повернути платіж.

Оплачене замовлення ніколи не змінюється через пізніше сповіщення про невдачу. Якщо Autopay повідомляє про ще один успішний платіж за оплаченим замовленням, примітка попереджає, що покупець міг заплатити двічі. Сповіщення про платіж, розпочатий з іншою службою Autopay, не застосовується, і примітка це пояснює. Примітки видно лише персоналу, у блоці Autopay payment на сторінці замовлення.

Блок Autopay payment

На сторінці замовлення відображається блок Autopay payment з OrderID Autopay, Service ID і середовищем, сумою та валютою, статусом платежу, ID транзакції Autopay, позначкою Test mode для тестових платежів і Autopay notes замовлення. Блок доступний лише для читання.

Повернення коштів

Повернення коштів через Autopay не підтримуються. Поверніть платіж у порталі Autopay, а потім зафіксуйте його в PrestaShop стандартними інструментами роботи із замовленням.

Ліцензійний ключ

Модуль працює з ліцензійним ключем VibeFox з vibefox.net. Блок ліцензії License — VibeFox Autopay Payment — це перший блок сторінки Modules > Module Manager > VibeFox Autopay Payment > Configure, над налаштуваннями. Введіть ключ у поле License key і натисніть Activate. Після цього блок показує ключ у замаскованому вигляді, статус (наприклад, дату, до якої дійсна ліцензія, і ваш домен), а також кнопки Check now для повторної перевірки статусу, Change key для введення іншого ключа і Remove key для видалення ключа з цього магазину. Нижче розташовані рядок Product: presta-payment-autopay і посилання Manage licenses and domains in your account, яке відкриває ваш обліковий запис vibefox.net. Змінювати ключ можуть лише співробітники з правом Configure для модуля. Тексти блоку відповідають мові back office (включено англійську та російську).

Якщо ключ не прийнято, блок показує причину, наприклад Key not found, This key belongs to another product, Domain limit reached або License expired on з датою. Після зміни адреси магазину або після звільнення слота домену в обліковому записі натисніть Check now. Якщо сервер ліцензій недоступний, модуль продовжує працювати за останнім відомим статусом.

Один ключ працює на одному домені — на домені основного магазину, зокрема в конфігурації з кількома магазинами. Видалення ключа з магазину не звільняє слот домену. Звільніть його у своєму обліковому записі vibefox.net.

Без активного ключа Autopay не показується покупцям на оформленні замовлення. Якщо оплату все ж розпочато, покупець бачить This payment method is not available. Please choose another one. Вітрина PrestaShop не знає, що ви увійшли в back office, тому спосіб оплати приховано й для вас: модуль можна налаштувати до купівлі ключа, але не можна перевірити на оформленні замовлення. Нагадування з'являється в Modules > Module Manager на вкладці Alerts. Наявні замовлення не змінюються: платежі, які вже розпочато, як і раніше підтверджуються.

Коли ліцензія закінчується, модуль продовжує працювати, але оновлення та підтримка потребують продовження. Статус автоматично перевіряється під час роботи в back office: раз на день протягом перших 14 днів після введення ключа, потім раз на тиждень. Cron-завдання не потрібне. Видалення або скидання модуля завжди видаляє ліцензійний ключ і статус ліцензії.

Усунення несправностей

Autopay не з'являється на оформленні замовлення: перевірте, що ліцензія активна, Enable/Disable увімкнено, у вибраному середовищі є Service ID і Shared key, а валюта кошика вибрана в Currencies. Сторінка налаштувань показує попередження, якщо чогось із цього бракує. У Payment > Preferences перевірте, що модуль дозволений для валюти кошика, країни покупця і групи покупця.

Платіж пройшов, але замовлення не створено: Autopay не доставив ITN або магазин його відхилив. Перевірте, що URL ITN, показаний у налаштуваннях, вказаний для служби в порталі Autopay (робочий або тестовий режим), що хеш-функція — SHA-256 і що Shared key у модулі відповідає службі. Перевірте, що магазин доступний з інтернету. Увімкніть Logging і перегляньте поле Log на сторінці модуля.

Журнал показує ITN rejected: invalid hash: Shared key не відповідає службі, або хеш-функція служби не SHA-256.

Журнал показує, що Service ID не налаштовано: сповіщення надійшло від служби, чий Service ID не введено в модуль, або чий Shared key порожній.

Журнал показує could not lock the cart, Autopay will retry: кошик у той самий момент обробляло інше сповіщення. Магазин відповідає так, щоб Autopay надіслав сповіщення повторно. Те саме відбувається, коли замовлення не вдалося створити, наприклад через вимкнений модуль.

Замовлення має статус Autopay payment on hold з приміткою про невідповідність: Autopay повідомив суму або валюту, що відрізняються від суми кошика. Перевірте транзакцію в порталі Autopay і вручну завершіть або поверніть кошти за замовленням.

Примітка каже, що сповіщення НЕ застосовано: платіж за цим замовленням не було розпочато з цією службою Autopay, наприклад тестове сповіщення для реального замовлення. Перевірте транзакцію в порталі Autopay.

Після оплати покупець потрапляє на головну сторінку: адресу повернення не вдалося перевірити, наприклад через те, що Service ID не введено в модуль. Замовлення не змінюється; воно слідує за ITN.

Покупець бачить This payment method is not available.: спосіб оплати не пропонується для цього кошика (вимкнено, немає облікових даних, валюту не вибрано або він заборонений у Payment > Preferences).

Видалення

Перейдіть до Modules > Module Manager, відкрийте меню поруч із VibeFox Autopay Payment і виберіть Uninstall. Ліцензійний ключ і статус ліцензії цього модуля завжди видаляються. Налаштування модуля, зокрема ключі, та журнал буде видалено. Модуль не має опції зберегти налаштування. Дані платежів Autopay і статус замовлення Autopay payment on hold завжди зберігаються. Наявні замовлення зберігають свої примітки про платежі та ID транзакцій.

Autopay є торговельною маркою її власника. Цей модуль не пов'язаний з Autopay і не схвалений Autopay.