Использование плагина ECommPay Simple Pay для CMS Magento

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

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

Схема работы

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

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

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

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

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

  • Pending Payment — платёж не прошёл.
  • Processing — платёж прошёл.
  • Complete — заказ исполнен.
  • Closed — полный возврат прошёл.
  • Partial Refund — частичный возврат прошёл.

Подключение

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

  1. Скопировать папку с плагином в корень проекта: в папку app/code.
  2. Запустить команды из корня проекта:
    ./magento indexer:reindex
php bin/magento cache:clean
php bin/magento cache:flush
php bin/magento setup:upgrade

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

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

Настройка

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

  1. Открыть Magento.
  2. Перейти на вкладку STORES > Configuration.


  3. Перейти на вкладку SALES > Payment Methods.


  4. В разделе OTHER PAYMENT METHODS выбрать ECommPay Simple Pay и задать необходимые настройки (см. далее).
  5. Убедиться, что в поле Test mode выбрано Yes.
  6. Щёлкнуть кнопку Save Config.


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

  • Поле Enabled — для отображения метода оплаты с помощью платёжной страницы ECommPay на сайте.
  • Параметры работы платёжной страницы ECommPay при её отображении:
    • Title — название метода оплаты на сайте.
    • Description — описание метода оплаты на сайте.
    • Payment page mode — способ отображения платёжной страницы: в модальном окне, объекте iframe HTML-страницы или в виде отдельной страницы в текущей вкладке браузера.
    • Iframe wrapper — идентификатор HTML-элемента оболочки платёжной страницы, в котором нужно отобразить iframe. Используется только для отображения платёжной страницы в объекте iframe.
    • Sort Order — номер в списке платёжных методов на сайте.
    • Send customer id — настройка автоматической передачи идентификатора пользователя (customer_id) в запросе на открытие платёжной страницы. Данная настройка доступна только при формировании заказов пользователями, зарегистрированными на сайте. Параметр customer_id используется для сохранения данных платёжных инструментов пользователей, подробнее — в разделе Сохранение платежных данных пользователя.
    • Language — язык платёжной страницы.
    • Currency — валюта платёжной страницы.
    • Additional parameters — дополнительные параметры работы платёжной страницы.

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

  • Другие параметры работы плагина:
    • New Order Status — статус при подтверждении заказа.
    • Поля Payment from Applicable Countries и Payment from Specific Countries для выбора стран, где доступен данный платежный метод.
  • Параметры Project ID и Secret key для подключения к платёжным решениям ECommPay.

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

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

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

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

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

После проведения тестовых заказов следует провести тестовые возвраты и проверить изменение статуса заказа и суммы в Magento, на вкладке Sales > Orders.

Для проведения возврата необходимо:
  1. Перейти на вкладку Sales.
  2. Выбрать необходимый заказ. Статус заказа должен быть Complete.
  3. Перейти в раздел Invoices внутри выбранного заказа.
  4. Выбрать инвойс.
  5. Щёлкнуть кнопку Credit Memo.
  6. Выбрать необходимые параметры для возврата.
  7. Щёлкнуть кнопку Refund.

После проведения возврата сумма заказа должна измениться на сумму возврата, а также должен появиться комментарий в Credit Memo.

Прим.: Статус заказа меняется на Partial Refund, если проведён частичный возврат, и на Closed, если проведён полный возврат.

Запуск

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

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

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

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


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

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

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

  1. Открыть Magento.
  2. Перейти на вкладку STORES > Configuration > SALES > Payment Methods в раздел OTHER PAYMENT METHODS и задать рабочие настройки:
    • Проверить, что в поле Enabled выбрано Yes.
    • Выбрать No в поле Test mode.
    • Заполнить поля Project ID и Secret key в соответствии со значениями, полученными в письме от службы технической поддержки ECommPay.
    • Убедиться, что для остальных параметров заданы необходимые значения.
  3. Щёлкнуть кнопку Save Config.

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

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

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

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

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

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