Использование плагина ECommPay payment module для CMS OpenCart 2.3

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

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

Схема работы

Взаимодействие с платёжными решениями ECommPay осуществляется через платёжную страницу.

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



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

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

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

  • Failed status — платёж не проведён.
  • Success status — платёж проведён.
  • Pending status — ожидание проведения платежа.
  • Reversed status — выполнен возврат средств до закрытия операционного дня, в котором был проведён платёж.
  • Refunded status — выполнен возврат средств после закрытия операционного дня, в котором был проведён платёж.

Подключение

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

  1. Открыть OpenCart.
  2. Перейти на вкладку Модули/Расширения > Установка расширений.
  3. Щёлкнуть кнопку Загрузить и выбрать файл с плагином (в формате ocmod.zip или ocmod.xml).
  4. Щёлкнуть кнопку Продолжить.
  5. Убедиться, что отобразилось сообщение: Модуль успешно установлен!

  6. Перейти на вкладку Модификаторы и убедиться, что в списке модификаторов появился ECommPay payment module.

  7. Щёлкнуть кнопку , чтобы обновить кеш модификатора.

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

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

Настройка

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

  1. Перейти на вкладку Модули/Расширения > Модули/Расширения и выбрать тип расширения — Оплата.

  2. Найти в таблице Оплата строку со способом оплаты ECommPay и щёлкнуть расположенную в этой строке кнопку .
  3. Щёлкнуть в этой же строке кнопку , чтобы настроить параметры работы плагина.

  4. Задать необходимые настройки (см. далее).
  5. Убедиться, что установлен флажок Test mode.
  6. Щёлкнуть кнопку , чтобы сохранить изменения.


На вкладке Settings настраиваются основные параметры работы плагина:

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

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

    • Language — язык платёжной страницы.
    • Currency — валюта платёжной страницы. Необходимо задать количество знаков после запятой. В противном случае сумма платежа отображается некорректно.
    • Popup mode — способ отображения платёжной страницы: во всплывающем окне или в той же вкладке.
    • Sort Order — номер в списке платёжных методов на сайте.
  • Geo Zone. Определяет регионы, для которых доступен данный платёжный метод.
  • Project ID и Secret key. Используются для подключения к платёжным решениям ECommPay.

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



На вкладке Order Status можно присвоить названия статусам заказа, описанным в пункте Схема работы.

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

После настройки параметров работы плагина следует провести тестовые заказы на сайте и проверить информацию по этим заказам в OpenCart, на вкладке Продажи > Заказы.

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

Запуск

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

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

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

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

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

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

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

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

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

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

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

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

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

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