Использование плагина ECommPay payments для CMS PrestaShop

В данной инструкции описана работа с плагином ECommPay payments версии 1.0. Этот плагин позволяет проводить оплаты и возвраты с использованием платёжных решений ECommPay на сайтах, созданных на базе CMS PrestaShop версии 1.7 или выше.

Скачать плагин ECommPay payments можно здесь.

Схема работы

Проведение платежей осуществляется через платёжную страницу ECommPay, а проведение возвратов — через клиентский интерфейс PrestaShop при выборе Refund ECommPay.

Рис.: Схема проведения платежей с использованием плагина

Запросы на открытие платёжной страницы формируются автоматически (с помощью плагина) при выборе ECommPay в методах оплаты.

Если по какой-либо причине платёж не прошёл, у пользователя есть возможность повторно ввести данные на платёжной странице.

По результатам проведения платежей и возвратов на сайт отправляются оповещения, которые также автоматически обрабатываются с помощью плагина. В соответствии с результатом платежа изменяется статус заказа:

  • Pending — платёж не прошёл.
  • Approved без изменения суммы заказа — платёж прошёл.
  • Approved с изменением суммы заказа — частичный возврат прошёл.
  • Возмещено — полный возврат прошёл.
  • Partially refunded — частичный возврат прошёл.

Подключение

Для подключения плагина необходимо:

  1. Открыть PrestaShop.
  2. Перейти на вкладку Улучшения > Модули > Модули и Сервисы.
  3. Щёлкнуть кнопку ЗАГРУЗИТЬ МОДУЛЬ и выбрать архив с плагином.


  4. Убедиться, что появилось сообщение Модуль установлен!


Тестирование

По умолчанию при активации плагина используется тестовый режим. Этот режим позволяет ознакомиться с работой плагина на сайте, к которому он подключён, без проведения реальных операций. В тестовом режиме можно настраивать и проверять работу плагина, проводить тестовые заказы, полный и частичный возвраты и просматривать информацию по ним.

Настройка

Для настройки параметров работы плагина в тестовом режиме необходимо:

  1. Перейти на вкладку Улучшения > Модули > Модули и Сервисы > Установленные модули.
  2. Выбрать ECommPay payments и щёлкнуть кнопку НАСТРОЙКА.
  3. Задать необходимые настройки (см. далее).
  4. Убедиться, что установлен флажок Test mode.
  5. Щёлкнуть кнопку Save Settings.


Параметры работы плагина включают в себя:

  • Параметры работы платёжной страницы ECommPay при её отображении:
    • Title — название метода оплаты на сайте.
    • Описание — описание метода оплаты на сайте.
    • Currency — валюта платёжной страницы.
    • Language — язык платёжной страницы.
    • Popup mode — способ отображения платёжной страницы: во всплывающем окне или в той же вкладке.
    • Additional parameters — дополнительные параметры работы платёжной страницы.

      Список этих параметров доступен здесь. При задании нескольких параметров их необходимо записывать с разделителем «&».

    • Параметры Project ID и Secret key для подключения к платёжным решениям ECommPay.

      В тестовом режиме эти параметры не используются.

Проведение тестовых заказов

После настройки параметров работы плагина следует провести тестовые заказы на сайте и проверить информацию по этим заказам в PrestaShop, на вкладке ПРОДАЖА > Заказы.

Прим.: В тестовом режиме для изменения статуса заказа с Pending на Approved после совершения платежа необходимо щёлкнуть кнопку Вернуться на сайт. В противном случае заказ остаётся со статусом Pending.

Проведение тестовых возвратов

После проведения тестовых заказов следует провести тестовые возвраты и проверить изменение статуса заказа и суммы в PrestaShop, на вкладке ПРОДАЖА > Заказы.

Для проведение возврата необходимо:
  1. Перейти на вкладку Заказы.
  2. Выбрать необходимый заказ. Статус заказа должен быть Approved.
  3. Щёлкнуть кнопку Частичное возмещение.
  4. Ввести сумму для возврата.
  5. Выбрать флажок Refund ECommPay и щёлкнуть кнопку Частичное возмещение.

После проведения возврата сумма заказа должна измениться на сумму возврата, а также должно появиться сообщение Частичный возврат средств успешно создан.

Прим.: Статус заказа меняется на Partially refunded, если проведён частичный возврат, и на Возмещено, если проведён полный возврат.

Запуск

После проверки работы плагина с использованием всех планируемых способов оплаты его можно переводить в рабочий режим. Для этого необходимо получить рабочие параметры и скорректировать настройки.

Получение рабочих параметров

Для получения параметров подключения к платёжным решениям ECommPay необходимо:

  1. Связаться со службой технической поддержки ECommPay и сообщить следующие параметры:
    • название и URL сайта,
    • валюту платёжной страницы,
    • URL для приёма оповещений (URL, указанный на вкладке Настройка).


  2. Получить от службы технической поддержки ECommPay значения следующих параметров:
    • Project ID — идентификатор сайта.
    • Secret key — секретный ключ, который генерируется для конкретного мерчанта на стороне ECommPay.

Задание рабочих настроек

Для задания рабочих настроек необходимо:

  1. Открыть PrestaShop.
  2. Перейти на вкладку Улучшения > Модули > Модули и Сервисы > Установленные модули.
  3. Выбрать ECommPay payments и щёлкнуть кнопку НАСТРОЙКА.
  4. Задать рабочие настройки:
    • Снять флажок Test mode.
    • Заполнить поля Project ID и Secret key в соответствии со значениями, полученными от службы технической поддержки ECommPay.
    • Убедиться, что для остальных параметров заданы необходимые значения.
  5. Щёлкнуть кнопку Save Settings.

Использование

После запуска плагина он работает автономно.

Мы рекомендуем контролировать проведение заказов на вкладке ПРОДАЖА > Заказы, а также следить, чтобы номера заказов были уникальными в рамках сайта. При дублировании номера заказа платёжная страница не открывается и заказ остаётся со статусом Pending.

Если после запуска плагина появляется необходимость переключить его в тестовый режим, следует обратить внимание на отображение метода оплаты на сайте. При установке флажка Test mode метод оплаты с помощью платёжной страницы ECommPay отображается на сайте, но все платежи проводятся как тестовые.

Перед переводом плагина обратно в рабочий режим, необходимо убедиться, что поля Project ID и Secret key заполнены в соответствии со значениями, полученными от службы технической поддержки ECommPay.

При возникновении вопросов по работе плагина следует обращаться в службу технической поддержки ECommPay support@ecommpay.com.