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

Вимоги

PrestaShop: 8.0–9.x.

PHP: 8.0 або новіша, з розширенням OpenSSL (воно потрібне, щоб зашифрувати запит і розшифрувати відповідь). Модуль не встановлюється на старіших версіях PHP і без OpenSSL.

Обліковий запис CCAvenue: потрібен обліковий запис мерчанта CCAvenue з Merchant ID, Access Code і Working Key. Access Code і Working Key видаються для домену сайту, тож згенеруйте їх для домену цього магазину. CCAvenue використовує ті самі облікові дані для тестового середовища; доступ до тестування має увімкнути для вашого облікового запису сама CCAvenue. Модуль використовує ендпоінти CCAvenue India.

Валюта: валюта кошика передається в CCAvenue без змін. Облікові записи CCAvenue за замовчуванням приймають INR; для інших валют у вашому обліковому записі CCAvenue потрібна мультивалютна обробка.

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

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

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

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

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

4. Введіть Merchant ID, Access Code і Working Key з вашої панелі CCAvenue та увімкніть Enable/Disable.

5. Залиште Test mode увімкненим під час тестування, а потім вимкніть його, щоб приймати реальні платежі.

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

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

Усі налаштування розташовані на сторінці модуля: Modules > Module Manager > VibeFox CCAvenue Payment > Configure. Кожен розділ має власну кнопку Save, яка зберігає всю сторінку. Над полями сторінка попереджає, якщо CCAvenue увімкнено, але не заповнено Merchant ID, Access Code або Working Key (тоді спосіб оплати приховано на оформленні замовлення, доки не заповнено всі три), показує CCAvenue test mode is on: customers are sent to test.ccavenue.com and no real money is taken., поки ввімкнено тестовий режим, і нагадує про мультивалютну обробку, коли валюта магазину за замовчуванням не INR.

CCAvenue

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

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

Description: текст під способом оплати на оформленні замовлення. За замовчуванням: Pay securely via Credit/Debit card, Net Banking, UPI or Wallet through CCAvenue.

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

Увійдіть до панелі мерчанта CCAvenue (M.A.R.S.) і відкрийте Settings > API Keys. Згенеруйте Access Code і Working Key для домену цього магазину. Пробіли в облікових даних видаляються під час збереження.

Merchant ID: ваш числовий Merchant ID CCAvenue. Якщо він містить щось, крім цифр, під час збереження з'являється повідомлення CCAvenue: the Merchant ID must contain digits only — the previous value was kept., раніше збережене значення залишається, а інші налаштування зберігаються.

Access Code: Access Code для цього вебсайту (Settings > API Keys).

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

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

Test mode: надсилає покупців до тестового середовища CCAvenue (test.ccavenue.com). CCAvenue використовує той самий Merchant ID, Access Code і Working Key для тестів і для робочого режиму; доступ до тестування має увімкнути для вашого облікового запису сама CCAvenue. У тестовому режимі оформлення замовлення показує під способом оплати TEST MODE: no real transactions will be processed. За замовчуванням: увімкнено. Вимкніть для реальних платежів.

Return URL

CCAvenue повертає покупця за адресою, зазначеною в цьому розділі. З дружніми URL вона має вигляд https://your-shop/module/wcp_ccavenue_payment/return, можливо з кодом мови, наприклад /en/. Модуль надсилає цю URL з кожним платежем (як URL перенаправлення та скасування), тож у CCAvenue нічого налаштовувати не потрібно. Вона має належати домену, зареєстрованому в CCAvenue.

Додатково

Debug log: записує події CCAvenue у файл logs/ccavenue_p_debug.log.php у папці модуля. Відкрити цей файл із вебу неможливо. Записуються лише посилання на замовлення, ID відстеження та статуси; ключі, дані картки, електронні адреси й адреси не записуються. За замовчуванням: вимкнено. Поки журнал вимкнено, нічого не записується, включно з помилками.

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

Delete data on uninstall: якщо увімкнено, видалення модуля прибирає налаштування модуля, журнал і посилання на замовлення CCAvenue. Замовлення та статуси замовлень модуля залишаються. За замовчуванням: вимкнено.

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

На етапі оплати покупець обирає спосіб оплати (за замовчуванням CCAvenue) і підтверджує вибір. Сторінка показує Thank you for your order. You are being redirected to CCAvenue to complete the payment. і надсилає покупця на платіжну сторінку CCAvenue. Без JavaScript покупець натискає Pay via CCAvenue або Back to checkout. На цьому етапі замовлення ще не існує.

Кожна спроба отримує нове посилання на замовлення CCAvenue, що складається з номера кошика та часу. Сума й валюта кошика, платіжні дані, адреса доставки (якщо відрізняється від платіжної) та секретний токен спроби надсилаються в зашифрованому запиті. Імена й адреси очищаються до символів і довжини, які приймає CCAvenue; країна та регіон передаються назвами, а телефон — лише цифрами. Покупець обирає картку, інтернет-банкінг, UPI, гаманець або EMI на сторінці CCAvenue.

Після оплати CCAvenue повертає покупця із зашифрованою відповіддю. Замовлення позначається як оплачене лише після підтвердження CCAvenue: відповідь має розшифровуватися вашим Working Key, належати спробі цього магазину та мати ту саму суму й валюту, що були надіслані та що вказані в кошику. Тоді замовлення створюється, і покупець бачить стандартну сторінку підтвердження замовлення з повідомленням Your CCAvenue payment has been received. Для платежу Awaited сторінка показує Your CCAvenue payment is awaiting confirmation from your bank. The order will be processed as soon as the payment is confirmed. Після невідповідності суми або валюти вона показує Your payment was received and is being reviewed by the shop. Якщо замовлення в очікуванні пізніше скасовано або воно завершилося невдачею без оплати, сторінка підтвердження показує Your CCAvenue payment was not completed. Please contact us about this order.

Якщо платіж не вдався, покупець повертається до оформлення замовлення з повідомленням Payment was not completed. Please try again or choose a different payment method. Якщо покупець скасовує платіж на сторінці CCAvenue, повідомлення таке: Payment was cancelled. You may try again. Якщо відповідь неможливо перевірити, повідомлення таке: We could not confirm the payment result. If your account was charged, please contact us before paying again. У таких випадках замовлення не створюється, кошик зберігається, і покупець може оплатити знову. Якщо для кошика вже є замовлення, нова спроба веде одразу на сторінку підтвердження цього замовлення, а не на другий платіж.

Результат береться лише з повернення покупця з CCAvenue: серверних повідомлень і запитів статусу немає. Якщо покупець закриє браузер до повернення, замовлення не створюється; перевірте платіж у панелі CCAvenue. Модуль не підтримує повернення коштів з PrestaShop, збережені картки, підписки чи регулярні платежі, форму картки на сайті та CCAvenue UAE або інші регіональні платформи.

Замовлення

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

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

Payment accepted: платіж підтверджено. Він реєструється з ID відстеження CCAvenue як ID транзакції, а примітка показує банківське посилання, ID відстеження та режим оплати.

Awaiting CCAvenue payment: CCAvenue повідомив про платіж як Awaited (банк ще не підтвердив його). Замовлення ніколи не позначається невдалим, поки гроші ще можуть бути захоплені. Перевірте його в панелі CCAvenue, перш ніж виконувати замовлення. Пізніша відповідь із тим самим ID відстеження все одно застосовується: Success встановлює Payment accepted, Failure — Payment error, Aborted — Canceled.

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

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

Блок платежу CCAvenue

Сторінка замовлення показує блок CCAvenue payment з ID замовлення CCAvenue, ID відстеження, статусом, банківським посиланням, режимом оплати та назвою картки, надісланою й отриманою сумою, датою та повідомленням CCAvenue, а також позначку Test mode для тестових платежів. Примітки CCAvenue є приватними повідомленнями замовлення, видимими лише в бек-офісі.

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

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

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

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

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

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

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

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

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

CCAvenue не з'являється на оформленні замовлення: перевірте, що ліцензію активовано, Enable/Disable увімкнено і всі три облікові дані заповнено: Merchant ID, Access Code і Working Key. Сторінка налаштувань показує попередження, якщо чогось бракує. У Payment > Preferences перевірте, що модуль дозволено для валюти кошика, країни покупця та групи покупця.

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

Кожен платіж завершується повідомленням We could not confirm the payment result: відповідь не можна розшифрувати. Working Key неправильний, належить іншому домену або скопійований із зайвими символами. Згенеруйте ключі для домену цього магазину та вставте їх знову. Увімкніть Debug log і перегляньте поле Log на сторінці модуля.

CCAvenue показує помилку до платіжної сторінки: перевірте, що Access Code і Working Key згенеровано для цього домену, що Return URL належить домену, зареєстрованому в CCAvenue, і, у тестовому режимі, що CCAvenue увімкнув доступ до тестування для вашого облікового запису. Для валюти, відмінної від INR, у вашому обліковому записі CCAvenue має бути увімкнено мультивалютну обробку.

Покупець бачить This payment method is temporarily unavailable: бракує одного з облікових даних або сума кошика дорівнює нулю. Debug log показує причину.

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

Покупець бачить Payment gateway error: encryption failed: запит не вдалося зашифрувати. Перевірте, що встановлено розширення PHP OpenSSL.

Merchant ID не змінюється під час збереження: значення містить щось, крім цифр. Введіть лише цифри вашого Merchant ID.

Замовлення має статус CCAvenue payment on hold або Awaiting CCAvenue payment: прочитайте примітку до замовлення (див. Статуси замовлень). Перевірте платіж у панелі CCAvenue, а потім виконайте замовлення або поверніть платіж.

Для розробників модуль має хук actionCcavenueRequestParams (змінює дані, що надсилаються в CCAvenue, до шифрування, наприклад від merchant_param2 до merchant_param5; значення не повинні містити &; не змінюйте amount, currency, order_id та merchant_param1).

Видалення

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

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