Использование плагина WooСommerce ecommpay для CMS WordPress

Введение

В этой статье представлена информация об использовании плагина WooCommerce ecommpay версии 2.1.2 для различных веб-сервисов, разработанных на базе CMS WordPress версий 5.0 и выше и использующих плагин WooCommerce версий 4.0 и выше.

С помощью описываемого плагина можно выполнять следующие действия:

проводить оплаты с использованием платёжных методов, доступных в рамках проекта мерчанта;
выполнять частичные и полные возвраты с использованием платёжных карт через интерфейс WooCommerce, а с использованием других платёжных методов — через интерфейсы Gate и Dashboard.
проводить, приостанавливать, возобновлять, изменять условия и отменять выполнение регулярных оплат (подписок) с использованием дополнения WooCommerce Subscriptions. Для работы с подписками могут использоваться платёжные карты, а также методы Apple Pay и Google Pay.

Вместе с тем, при работе с плагином можно использовать различные дополнительные возможности, обеспечиваемые со стороны ecommpay для Payment Page (подробнее) и со стороны разработчиков плагина WooCommerce для веб-сервисов. Например, можно поддерживать для пользователей повторные попытки оплаты и регулировать применение плагина в разных странах. Применяя возможности такого рода, можно подстраиваться под различные особенности бизнеса, улучшать пользовательские сценарии, повышать конверсию платёжной формы и проходимость платежей.

Для подключения возможностей, предоставляемых ecommpay, следует обращаться к технической документации на этом портале и, по мере необходимости, к специалистам ecommpay.

Схема работы

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

Рис.: Проведение оплаты с использованием плагина WooCommerce. Описание шагов

Пользователь на стороне веб-сервиса инициирует оплату с использованием плагина WooСommerce .
В соответствии с параметрами работы плагина формируется запрос на открытие Payment Page.
Запрос на открытие Payment Page поступает в платёжную платформу.
На стороне платёжной платформы выполняется обработка запроса.
Выполняется подготовка к открытию Payment Page в соответствии с параметрами работы плагина.
Пользователю отображается платёжная форма.
Пользователь выполняет необходимые действия для оплаты.
В платёжную платформу поступает запрос на оплату.
Запрос передаётся в платёжную среду.
В платёжной среде выполняется обработка запроса.
Из платёжной среды к платёжной платформе направляется информация о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От платёжной платформы к Payment Page направляется информация о результате оплаты.
Информация о результате оплаты отображается пользователю в платёжной форме.

Заказам, сформированным на стороне веб-сервиса, присваиваются статусы в соответствии с моделью выполнения заказов WooCommerce (подробнее), а платежам, проводимым через платёжную платформу ecommpay — статусы в соответствии с моделью проведения платежей ecommpay (подробнее).

Установка

Чтобы начать работать с плагином WooCommerce ecommpay версии 2.1.2, его необходимо скачать и установить. При этом, если ранее использовалась одна из предыдущих версий этого плагина, его рекомендуется предварительно деактивировать.

Для установки версии 2.1.2 (или обновления плагина до этой версии) необходимо перейти в интерфейс WordPress и выполнить следующие действия:

Перейти в раздел Plugins и в выпадающем меню выбрать Add New.
Щёлкнуть кнопку Upload Plugin.
Выбрать предварительно скачанный zip-архив с плагином.
Щёлкнуть кнопку Install Now и дождаться завершения установки.
Прим.: Если перед обновлением плагина предыдущая версия не была деактивирована, то после завершения установки плагина необходимо щёлкнуть кнопку Run the updater для обновления настроек. Иначе плагин может работать некорректно.
Активировать плагин с помощью кнопки Activate.

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

Общая информация

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

Тестирование через тестовый режим работы плагина. В этом режиме доступна работа с регулярными оплатами (если используется дополнение WooCommerce Subscriptions), проведение оплат и выполнение тестовых возвратов по ним, а также получение информации о созданных в тестовом режиме заказах и платежах (подробнее — в документации WooCommerce).
Тестирование через тестовую среду платёжной платформы ecommpay. В этом режиме доступно проведение платежей с использованием тестовых карт, а использование других платёжных методов необходимо согласовывать со специалистами технической поддержи ecommpay. Для использования этого варианта необходимо подключиться к тестовой среде ecommpay (это можно сделать через сайт компании) и использовать полученные от ecommpay идентификатор тестового проекта и соответствующий ему секретный ключ в значении обязательных параметров работы плагина.

Настройка параметров

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

Открыть карточку плагина в интерфейсе WordPress.
Для этого необходимо перейти в раздел WooCommerce, в выпадающем меню выбрать Settings, перейти на вкладку Payments, выбрать ecommpay и щёлкнуть кнопку Manage.
Задать возможность использования плагина WooCommerce, предоставляемого ecommpay.
Для этого необходимо перейти на вкладку General и установить флажок Enable plugin.
Установить режим работы плагина.
Для работы в тестовом режиме во вкладке General необходимо установить флажок Test mode, в рабочем — снять.
При установке тестового режима — задать обязательные параметры для подключения к тестовой среде платёжной платформы:
- Project ID — идентификатор тестового проекта, полученный от ecommpay.
- Secret Key — секретный ключ для взаимодействия с ecommpay.
При необходимости задать остальные параметры плагина. Например, параметры работы с платёжной формой.
- Display mode — вариант отображения платёжной формы: в объекте iframe, в модальном окне или в используемой вкладке.
- Close on misclick — возможность закрытия платёжной формы, отображаемой в модальном окне, по щелчку кнопки на область вне этого окна.
- Language — язык отображения платёжной формы.
Сохранить параметры работы плагина.
Для этого необходимо щёлкнуть кнопку Save changes.

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

После настройки работы плагина рекомендуется провести тестовые оплаты в веб-сервисе и получить информацию о них через интерфейс WordPress в разделе Orders. Для проведения оплат через тестовый режим работы плагина можно использовать номера тестовых карт, представленных в документации WooCommerce, а при тестировании через тестовую среду платёжной платформы ecommpay — в документации ecommpay и получать необходимые итоговые статусы оплат.

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

Перейти к списку заказов.
Для этого необходимо перейти в раздел WooCommerce и в выпадающем списке выбрать пункт Orders.
Выбрать из списка заказ, по которому необходимо выполнить возврат средств и щёлкнуть кнопку Refund.
Следует учитывать, что выполнение возвратов доступно только для заказов со статусами Processing или Completed.
Указать количество товаров, которые необходимо вернуть (сумма возврата при этом рассчитывается автоматически), либо указать сумму возврата, не изменяя количество товаров в заказе.
При необходимости добавить описание возврата в поле Reason for refund.
Подтвердить выполнение возврата.
Для этого необходимо щёлкнуть кнопку Refund via ecommpay.

После выполнения возврата следует убедиться, что сумма заказа изменилась на сумму возврата, а также получено уведомление о выполненной операции, которое отображается в правой боковой панели Order notes. При выполнении частичного возврата заказу присваивается статус Processing или Completed, полного возврата — Refunded.

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

Общая информация

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

В рабочем режиме плагина доступны следующие возможности:

Проведение оплат и выполнение частичных и полных возвратов по ним.
Автоматическое открытие Payment Page в соответствии с заданными параметрами.
Отображение информации о сформированных заказах и их актуальных статусах в интерфейсе WordPress.
Отображение информации о платежах и их актуальных статусах в интерфейсе WordPress.

Также при использовании дополнения WooCommerce Subscription в рабочем режиме доступно:

Добавление в число продуктов веб-сервиса продуктов с оплатой на регулярной основе (по подписке, списания в рамках которой инициируются мерчантом и автоматически выполняются по заданному графику на фиксированную сумму) и указание свойств для каждого такого продукта. К таким свойствам относятся, в частности, сумма и периодичность списаний (ежедневно, еженедельно, ежемесячно и так далее), стоимость регистрации подписки, период бесплатного использования (подробнее).
Регистрация, проведение, приостановка, отмена, возобновление, а также изменение условий выполнения регулярных оплат с использованием платёжных карт, а также методов Apple Pay и Google Pay (подробнее).
Покупка нескольких продуктов с оплатой на регулярной основе в рамках одного заказа.
Информирование пользователей о различных событиях, связанных с регулярными оплатами, например: о списании средств, приостановке, отмене и возобновлении списаний, о сбоях при попытке списания средств и необходимости оплаты (подробнее).

Настройка параметров группы Payment

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

Таким образом, чтобы настроить плагин для проведения разовых оплат, со стороны мерчанта необходимо выполнить следующее:

Открыть карточку плагина в интерфейсе WordPress.
Для этого необходимо перейти в раздел WooCommerce, в выпадающем меню выбрать Settings, на вкладке Payments выбрать ecommpay и щёлкнуть кнопку Manage.
Задать возможность использования плагина WooCommerce, предоставляемого ecommpay.
Для этого необходимо перейти на вкладку General и установить флажок Enable plugin.
Установить режим работы плагина.
Для этого необходимо снять флажок Test mode.
Задать обязательные параметры работы плагина.
- Project ID — идентификатор рабочего проекта, полученный от ecommpay.
- Secret Key — секретный ключ для взаимодействия с ecommpay.
При необходимости задать остальные параметры работы плагина, такие как:
- Параметры отображения варианта оплаты в веб-сервисе.
  - Title — название.
  - Customer message — текст, который отображается пользователю при выборе варианта оплаты через ecommpay.
  - Order button text — название кнопки для перехода к оплате заказа (например, «Оплатить заказ»).
- Параметры работы с платёжной формой.
  - Display mode — вариант отображения платёжной формы: в объекте iframe, в модальном окне или в используемой вкладке.
  - Close on misclick — использование режима, при котором модальное окно с платёжной формой закрывается при щелчке за его пределами.
  - Language — язык отображения платёжной формы.
- Параметры, расположенные во вкладке Shop Admin.
  - Возможность отображения статусов платежей в разделе Orders.
    Для этого необходимо перейти на вкладку Shop Admin и установить флажок Fetch Payment Info.
  - Если в рамках используемого проекта актуально отображение в платёжной форме дополнительных полей для передачи информации о пользователях в платёжную платформу ecommpay, выбрать эти поля.
    Для этого необходимо перейти на вкладку Shop Admin и выбрать доступные варианты в параметре Additional Information.
Сохранить параметры работы плагина.
Для этого необходимо щёлкнуть кнопку Save changes.

Настройки параметров группы Subscriptions

Если используется дополнение WooCommerce Subscriptions, в разделе WooCommerce появляется дополнительная вкладка Subscriptions. В этой вкладке отображаются параметры группы Subscriptions, актуальные для работы с регулярными оплатами. Например, здесь можно задавать текст для кнопок, который отображается в веб-сервисе при оплате и добавлении в корзину товаров с оплатой по подписке, варианты возобновления регулярных оплат, а также другие параметры.

Информация о работе с регулярными оплатами через дополнение WooCommerce Subscriptions представлена в документации WooCommerce.

Контроль заказов

После создания заказов можно получать информацию о них в пункте Orders раздела WooCommerce. Здесь доступна возможность поиска и фильтрации данных, ниже отображается список заказов (Order), дата создания (Date), сумма каждого заказа (Total) и другая информация.

Если в параметрах работы плагина установлен флажок Fetch Payment Info, для каждого заказа отображается соответствующий ему статус платежа (Payment) в платформе ecommpay.

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

Order Notes — содержит различные уведомления, например об изменении статуса заказа и соответствующего ему платежа.
ecommpay Payment — содержит информацию о платеже: его сумму, валюту, идентификатор, метод оплаты, тип и статус операции в платформе ecommpay. В этой панели также расположена кнопка Refresh, по щелчку которой можно получить актуальную информацию о платеже в платформе ecommpay.

Информация о работе с заказами также представлена в документации WooCommerce.

Контроль подписок

Чтобы получить информацию о регулярных оплатах, следует перейти в пункт Subscriptions раздела WooCommerce. Как и в пункте Orders, здесь доступна возможность поиска и фильтрации данных. Чтобы посмотреть более детальную информацию о регулярной оплате, включающую её статус, сумму и дату следующего списания, следует перейти в карточку подписки.

Информация о работе с регулярными оплатами представлена в документации WooCommerce.