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

Вимоги

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

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

Валюта магазину: AUD, NZD, SGD, HKD або MYR. Для інших валют кошика спосіб оплати не показується під час оформлення замовлення. Платіж списується у валюті кошика.

Обліковий запис eWAY: потрібен обліковий запис мерчанта eWAY з доступом до Rapid API, а також його ключ і пароль Rapid API, які можна отримати в MyeWAY у розділі Settings, API Key. Для тестування потрібен обліковий запис sandbox eWAY з власними ключем і паролем. Ключі sandbox і робочі ключі відрізняються. У eWAY нічого налаштовувати не потрібно: URL повернення передається з кожним платежем.

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

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

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

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

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

4. Введіть ключ і пароль API sandbox, залиште ввімкненим Sandbox Mode, увімкніть Enable/Disable, натисніть Save і створіть тестове замовлення.

5. Введіть ключ і пароль робочого API, вимкніть Sandbox Mode і натисніть Save.

6. За бажанням додайте URL cron, що відображається на сторінці Configure, до cron-завдань вашого сервера (див. Конфігурація).

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

Конфігурація

Усі налаштування розташовані на сторінці модуля: Modules > Module Manager > VibeFox eWAY Payment Gateway > Configure. Кожен розділ має власну кнопку Save, яка зберігає всю сторінку. Над полями бейдж показує режим: SANDBOX — payments go to the eWAY sandbox, no real money is charged. або LIVE — real payments are taken with the live API key. Сторінка попереджає, якщо не заповнені ключ і пароль API поточного режиму (тоді спосіб оплати не показується під час оформлення замовлення), і якщо валюта магазину за замовчуванням не підтримується eWAY.

eWAY

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

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

Description: текст під способом оплати під час оформлення замовлення. За замовчуванням: Pay securely using your credit card via eWAY. You will be redirected to the eWAY secure payment page.

Облікові дані API

Ключ і пароль Rapid API містяться в MyeWAY у розділі Settings, API Key. eWAY має інструкції для робочих ключів і ключів sandbox, посилання на які наведені в цьому розділі. Ключі sandbox і робочі ключі відрізняються.

Sandbox Mode: платежі надсилаються в sandbox eWAY з ключем і паролем sandbox. Реальні гроші не списуються. За замовчуванням: увімкнено. Вимкніть, щоб приймати реальні платежі з робочим ключем. Поки режим увімкнено, покупці бачать Test mode: no real payment is taken. під способом оплати.

Live API Key: ключ Rapid API вашого робочого облікового запису eWAY.

Live API Password: пароль Rapid API вашого робочого облікового запису eWAY.

Sandbox API Key: ключ Rapid API вашого sandbox-облікового запису eWAY (обліковий запис партнера/розробника).

Sandbox API Password: пароль Rapid API вашого облікового запису sandbox eWAY.

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

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

Return URL / re-checks: в eWAY не потрібно налаштовувати жодного webhook чи URL повернення, оскільки URL повернення передається з кожним платежем. Це поле показує необов'язковий URL cron. Викликайте його з cron-завдання сервера, наприклад кожні 15 хвилин. Якщо покупець оплатив і закрив браузер, не повернувшись до магазину, платіж запитується в eWAY приблизно через годину, і замовлення створюється. Якщо eWAY недоступний, перевірка повторюється до трьох разів. Тримайте цей URL у таємниці: він містить токен, а виклик із неправильним токеном отримує відповідь Forbidden.

Замовлення

Order Status on Success: статус замовлення після підтвердження платежу eWAY.

Підтверджені сума або валюта, які не збігаються із замовленням, завжди переводять замовлення в eWAY payment on hold.

Додатково

Debug log: записує виклики API і результати платежів у logs/eway_p_debug.log.php у папці модуля. Файл не можна відкрити з веб-браузера. Дані картки, ключі, паролі, e-mail покупців і коди доступу не записуються. Помилки записуються завжди. За замовчуванням: вимкнено.

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

Delete all plugin data on uninstall: якщо увімкнено, видалення модуля стирає налаштування шлюзу та журнал. Платіжні дані eWAY за замовленнями та статус eWAY payment on hold завжди зберігаються. За замовчуванням: вимкнено.

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

На етапі оплати покупець обирає спосіб оплати (за замовчуванням Credit Card (eWAY)) і підтверджує. Модуль запитує в eWAY сторінку оплати на суму кошика у валюті кошика, з PS- і номером кошика як довідковим номером рахунку, а також з адресою для рахунку та e-mail покупця, і перенаправляє покупця на eWAY Responsive Shared Page. Там покупець сплачує карткою. Списання відбувається одразу. На цьому етапі замовлення ще немає.

Після оплати покупець повертається до вашого магазину. Модуль не довіряє браузеру: він запитує в eWAY (сервер-сервер) результат сторінки оплати, створеної для цього кошика. Замовлення позначається оплаченим лише після того, як eWAY підтвердить його і підтверджені сума та валюта збігаються з кошиком. Потім замовлення створюється, і покупець бачить стандартну сторінку підтвердження замовлення з написом Your payment with eWAY has been received. Для замовлення на утриманні сторінка показує Your payment was received and is being reviewed by the store. We will contact you if anything is needed.

Якщо в цей момент запитати eWAY неможливо, сторінка Payment confirmation показує We have not received the confirmation of your payment from eWAY yet. If you completed the payment, this order will be updated shortly — please do not pay again. з кнопкою Check again і кнопкою Back to checkout. Замовлення створюється, коли покупець перевіряє знову або коли запускається URL cron.

Якщо платіж відхилено, покупець повертається до оформлення замовлення з причиною, наприклад Your payment was declined: D4451 Insufficient funds. Please try again or use a different payment method. Якщо покупець натискає Cancel на сторінці eWAY, модуль спершу перевіряє в eWAY, що нічого не сплачено (наприклад, в іншій вкладці). Після цього покупець бачить You cancelled the payment on the eWAY page. Your order has not been paid — you can try again. Якщо оплату не було завершено, повідомлення: The payment was not completed. Please try again. Кошик у всіх випадках зберігається.

Покупець може спробувати знову. Перед створенням нової сторінки оплати попередня сторінка кошика перевіряється в eWAY. Якщо вона вже оплачена, замість другого списання створюється замовлення. Якщо eWAY не може створити сторінку оплати, покупець залишається на оформленні замовлення з коротким повідомленням, наприклад Payment error: Unable to connect to eWAY. Please try again. або eWAY could not start the payment з кодами помилок eWAY.

eWAY не надсилає сповіщень сервер-сервер для Shared Page: результат отримується під час повернення покупця і через URL cron. Модуль не має полів для картки на вашому сайті, не зберігає картки чи підписки, не підтримує авторизацію без списання та окреме захоплення, і не оцінює бали шахрайства Beagle (транзакції, заблоковані правилами eWAY проти шахрайства, відхиляються самим eWAY).

Замовлення та повернення коштів

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

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

Payment accepted or Delivered: платіж підтверджено. Статус відповідає Order Status on Success. Платіж записується з ID транзакції eWAY, а примітка показує ID транзакції, код авторизації, відповідь і режим (sandbox або робочий).

eWAY payment on hold: eWAY підтвердив суму або валюту, що відрізняються від кошика (наприклад, Approved for partial amount, або кошик було змінено після того, як покупець відкрив сторінку оплати), платіж було підтверджено після того, як покупець скасував його на сторінці eWAY, або його підтверджено після скасування замовлення. Платіж записується із сумою, яку списав eWAY, а примітка пояснює це. Перевірте замовлення та опрацюйте його або поверніть кошти за платежем.

Refunded: платіж повністю повернено через модуль.

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

Блок оплати eWAY

Сторінка замовлення показує блок eWAY payment з ID транзакції, кодом авторизації, відповіддю eWAY, статусом, режимом і довідковим номером рахунку, сумою оплати та повернення, бейджем Sandbox для тестових платежів, історією повернень і eWAY notes замовлення.

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

У блоці eWAY payment введіть суму (підставляється сума, яка ще не повернута), за бажанням причину, і натисніть Refund via eWAY. Підтвердіть запитання Refund this amount through eWAY? This cannot be undone. Підтримуються повні та часткові повернення. Потрібне право редагувати замовлення; доступ до сторінок модулів не потрібен. Повернення здійснюються в сумі та валюті, які списав eWAY, тож після підтвердження часткової суми можна повернути не більше того, що покупець фактично сплатив, а не суму замовлення. Повернення надсилається в тому середовищі, де було здійснено платіж (sandbox або робочому), тож мають бути заповнені ключ і пароль API цього середовища. Якщо eWAY відхиляє повернення, блок показує eWAY refund failed: з кодами eWAY, і повернення не записується. Успішне повернення додається до історії повернень і приміток з ID транзакції повернення eWAY. Повне повернення переводить замовлення в статус Refunded. Часткове повернення статус не змінює. Повернення доступні після того, як eWAY підтвердив платіж.

Модуль не створює кредитні авізо. Стандартні кнопки повернення PrestaShop на сторінці замовлення не повертають гроші через eWAY. Повернення, оформлені в MyeWAY, не синхронізуються з PrestaShop. За потреби оновіть замовлення вручну.

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

Модуль працює з ліцензійним ключем VibeFox з vibefox.net. Блок ліцензії License — VibeFox eWAY Payment Gateway — це перший блок на сторінці Modules > Module Manager > VibeFox eWAY Payment Gateway > Configure, над налаштуваннями. Введіть ключ у License key і натисніть Activate. Після цього блок показує ключ у прихованому вигляді, статус (наприклад, дату, до якої ліцензія активна, і ваш домен) та кнопки Check now, щоб перевірити статус знову, Change key, щоб ввести інший ключ, і Remove key, щоб видалити ключ із цього магазину. Нижче розміщені рядок Product: presta-payment-eway і посилання 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.

Без активного ключа eWAY не показується покупцям під час оформлення замовлення. Якщо платіж все ж розпочато, покупець бачить Цей спосіб оплати недоступний. Будь ласка, оберіть інший. Вітрина PrestaShop не знає, що ви увійшли в back office, тож спосіб оплати приховано і для вас: модуль можна налаштувати до купівлі ключа, але не можна перевірити під час оформлення замовлення. Нагадування з'являється в Modules > Module Manager на вкладці Alerts. Наявні замовлення не змінюються: платежі, які вже почалися, як і раніше підтверджуються, а повернення працюють.

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

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

eWAY does not appear at checkout: перевірте, що ліцензія активна, Enable/Disable увімкнено, ключ і пароль API поточного режиму заповнені (поля sandbox у режимі sandbox, робочі поля в робочому режимі), а валюта кошика — AUD, NZD, SGD, HKD або MYR. На сторінці налаштувань з'являється попередження, якщо облікові дані не заповнені. У Payment > Preferences перевірте, чи дозволено модуль для валюти кошика, країни покупця та групи покупця.

The payment went through, but no order was created: покупець не повернувся з eWAY, або в цей момент запитати eWAY не вдалося. eWAY не надсилає сповіщень для Shared Page. Налаштуйте URL cron з Return URL / re-checks: він підхопить платіж приблизно через годину. Перевірте транзакцію в MyeWAY і подивіться поле Log на сторінці модуля.

The customer sees This payment method is temporarily unavailable: ключ або пароль API поточного режиму не заповнені, або eWAY їх відхилив. Перевірте облікові дані поточного режиму.

The customer sees eWAY could not start the payment: eWAY повернув коди помилок, які показано в повідомленні. Часто причина в некоректних платіжних даних.

The customer sees We could not match this payment to an order: посилання повернення не належить до кошика цього магазину, або eWAY підтвердив платіж для іншого довідкового номера рахунку. Якщо з покупця списали гроші, знайдіть платіж у MyeWAY.

The customer sees We could not check the status of your previous payment attempt: інший запит обробляв той самий кошик. Покупець може спробувати знову за хвилину.

Order is eWAY payment on hold after payment: прочитайте eWAY notes у блоці eWAY payment (див. розділ Статуси замовлення), потім опрацюйте замовлення або поверніть кошти за платежем.

Refund fails with a message about the sandbox or live mode: замовлення було оплачено в цьому середовищі, а його ключ і пароль API не заповнені. Введіть їх і повторіть спробу.

Refund fails with at most … can be refunded: сума більша за ту, яку eWAY списав, мінус уже здійснені повернення.

Для розробників: README модуля описує хук actionWcpEwaySupportedCurrencies, якщо ваш обліковий запис eWAY підключено до додаткових валют.

Видалення

Перейдіть до Modules > Module Manager, відкрийте меню поруч із VibeFox eWAY Payment Gateway і виберіть Uninstall. Ліцензійний ключ і статус ліцензії цього модуля завжди видаляються. Якщо Delete all plugin data on uninstall увімкнено, налаштування шлюзу та журнал видаляються. Якщо вимкнено, усі налаштування зберігаються для повторного встановлення. Платіжні дані eWAY за замовленнями та статус eWAY payment on hold завжди зберігаються, тож замовлення, оплачені раніше, можна повернути навіть після повторного встановлення. Наявні замовлення зберігають свої платіжні примітки та ID транзакцій.

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