Использование плагина Ecommpay Payments для платформы BigCommerce
статья о порядке применения плагина для встраивания Payment Page в сайты на базе платформы BigCommerce
Введение
В этой статье представлена информация о работе с платёжным плагином Ecommpay Payments для платформы BigCommerce. Этот плагин может использоваться в веб-сервисах, разработанных на базекоторые разработаны и поддерживаются на базе актуальных версий платформы BigCommerce, и позволяет открывать пользователям платёжную форму Payment Page от Ecommpay, а также обеспечивать все необходимые действия для проведения платежей.
Плагин Ecommpay Payments устанавливается через каталог плагинов Apps&Integrations и административный интерфейс BigCommerce, позволяет открывать пользователям платёжную форму Payment Page от Ecommpay и обеспечивать все необходимые действия для проведения платежей, как в части взаимодействия с пользователями, так и в части взаимодействия с платёжной платформой Ecommpay, с передачей и приёмом всей необходимой информации.
Технически плагин разворачивается в платёжной платформе Ecommpay и взаимодействие веб-сервиса с плагином строится через сетевое подключение к нему. Таким образом, на стороне веб-сервиса всегда используется актуальная версия плагина.
Общая информация
Возможности
При использовании плагина Ecommpay Payments для платформы BigCommerce можно:
- Встраивать в любой веб-сервис на базе платформы BigCommerce возможность вызова платёжной формы Payment Page от Ecommpay.
Для этого достаточно установить плагин и настроить его использование через интерфейс BigCommerce.
- Конфигурировать варианты использования плагина для разных веб-сервисов на базе платформы BigCommerce.
При работе с группой веб-сервисов на базе платформы BigCommerce можно подключать, настраивать и применять отдельные конфигурации плагина для каждого из таких сервисов, обеспечивая адаптивность к их специфике.
- Настраивать использование различных платёжных методов, доступных для работы через плагин.
Технически для подключения отдельных платёжных методов может быть достаточно минимальных действий в интерфейсе BigCommerce, а все организационные вопросы можно решать через курирующего менеджера Ecommpay.
- Тестировать работу платёжной формы и возможности проведения платежей.
Для этого следует оформить тестовый проект в платёжной платформе Ecommpay (что можно сделать через заявку на основном сайте компании) и задать параметры этого проекта через интерфейс BigCommerce.
- Проводить разовые оплаты в одну и в две стадии.
В рамках одного проекта можно выбрать один из вариантов проведения оплат: с незамедлительным списанием средств (в одну стадию) с использованием любого из подключённых платёжных методов либо с предварительной блокировкой и последующим списанием средств (в две стадии) с использованием любого из методов, для которого поддерживается проведение таких оплат через Payment Page.
- Выполнять частичные и полные возвраты средств по оплатам, проведённым с помощью плагина.
Для этого можно использовать интерфейс BigCommerce и, если актуально, интерфейсы платёжной платформы Ecommpay (пользовательский интерфейс Dashboard и Gate API). Вместе с тем стоит учитывать, что при использовании интерфейсов платёжной платформы Ecommpay информация о платежах в интерфейсе BigCommerce обновляется, только если настроена отправка оповещений со стороны платёжной платформы (подробнее).
- Контролировать информацию о платежах, проводимых с помощью плагина.
Для этого можно использовать интерфейс BigCommerce и, если актуально, — интерфейсы Dashboard и Data API от Ecommpay.
- Управлять заказами, оплаты по которым проводятся с помощью плагина, через интерфейс BigCommerce.
Помимо прочего, в рамках такого управления можно отменять отдельные заказы и корректировать их статусы вручную. При этом следует учитывать, что автоматическое изменение статусов заказов при работе с плагином Ecommpay Payments не предусмотрено, но может быть настроено специалистами мерчанта с использованием возможностей платформы BigCommerce или иных решений.
- Настраивать способы открытия платёжной формы Payment Page и варианты применения её дополнительных возможностей, адаптируя форму под специфику конкретного веб-сервиса.
При работе с плагином Ecommpay Payments для платёжной формы можно настраивать способы её открытия при работе с классическими карточными платежами (подробнее далее), а также варианты использования различных дополнительных возможностей (подробнее). В частности, можно применять процедуру подтверждения зачислений при работе с платёжными методами Open Banking, делать доступными для пользователей повторные попытки оплаты (подробнее) и подключать отправку пользователям уведомлений о результатах оплат (подробнее), хотя вместе с тем отдельные возможности, как например проведение оплат по токенам, могут быть недоступны для работы с плагином.
Такой спектр возможностей позволяет подстраиваться под различные особенности бизнеса, гибко настраивать пользовательские сценарии и обеспечивать высокий уровень конверсии платёжной формы и проходимости платежей. Чтобы подключать и применять при этом возможности, предоставляемые Ecommpay, следует обращаться к технической документации на этом портале и, по мере необходимости, к специалистам Ecommpay.
Схемы работы
В схемах проведения оплат в одну и две стадии с использованием плагина Ecommpay Payments задействуются пользователь, веб-сервис со встроенным в него плагином, платёжная форма Payment Page, платёжная платформа и платёжная среда. При этом с помощью плагинаПри использовании плагина Ecommpay Payments на стороне веб-сервиса обеспечиваются автоматический вызов Payment Page и автоматическое взаимодействие с платёжной платформой в соответствии с заданными параметрами работы.
В рамках одностадийной оплаты на основании одного исходного запроса выполняются разовый перевод средств от пользователя к мерчанту и отправка к веб-сервису оповещения о результате проведения платежа.
- Пользователь на стороне веб-сервиса выбирает вариант оплаты с использованием плагина Ecommpay Payments.
- На стороне веб-сервиса формируется и отправляется в платёжную платформу Ecommpay запрос на открытие платёжной формы Payment Page.
- Запрос на открытие Payment Page поступает в платёжную платформу.
- В платформе выполняется обработка запроса, с проверкой его корректности.
- В платформе обеспечивается подготовка к открытию Payment Page.
- Пользователю отображается платёжная форма.
- Пользователь выполняет необходимые действия и подтверждает готовность провести оплату.
- В платёжную платформу поступает итоговый запрос на оплату (со всеми необходимыми сведениями).
- Запрос передаётся в платёжную среду.
- В платёжной среде выполняется обработка платежа. При этом, если необходимо, обеспечивается выполнение дополнительных действий со стороны платформы и пользователя (например, для аутентификации 3‑D Secure).
- Из платёжной среды к платёжной платформе направляется информация о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты. Оно автоматически обрабатывается с помощью плагина, благодаря чему в интерфейсе BigCommerce обновляется информация о состоянии платежа.
- От платёжной платформы к Payment Page направляется информация о результате оплаты.
- Информация о результате оплаты отображается пользователю в веб-сервисе мерчанта на странице с информацией об оплате заказа.
В рамках двухстадийной оплаты сначала выполняется блокировка средств пользователя, а затем — списание заблокированных средств или отмена блокировки. При этом на каждой стадии к веб-сервису отправляется оповещение с информацией о соответствующем результате.
В рамках двухстадийной оплаты на основании исходного запроса (на первой стадии) выполняется блокировка средств пользователя, а затем (на второй стадии) на основании подтверждающего запроса или автоматически по истечении заданного срока выполняется списание заблокированных средств или отмена блокировки. При этом на каждой стадии к веб-сервису отправляется оповещение с информацией о соответствующем результате.
- Пользователь на стороне веб-сервиса выбирает вариант оплаты с использованием плагина Ecommpay Payments.
- На стороне веб-сервиса формируется и отправляется в платёжную платформу Ecommpay запрос на открытие платёжной формы Payment Page.
- Запрос на открытие Payment Page поступает в платёжную платформу.
- В платформе выполняется обработка запроса, с проверкой его корректности.
- В платформе обеспечивается подготовка к открытию Payment Page.
- Пользователю отображается платёжная форма.
- Пользователь выполняет необходимые действия и подтверждает готовность провести оплату.
- В платёжную платформу поступает запрос на выполнение блокировки средств.
- Запрос передаётся в платёжную среду.
- В платёжной среде выполняется обработка платежа и блокировка средств пользователя. При этом, если необходимо, обеспечивается выполнение дополнительных действий со стороны платформы и пользователя (например, для аутентификации 3‑D Secure).
- Из платёжной среды к платёжной платформе направляется информация о результате блокировки средств.
- От платёжной платформы к веб-сервису направляется оповещение о результате блокировки. Оно автоматически обрабатывается с помощью плагина, благодаря чему в интерфейсе BigCommerce обновляется информация о состоянии платежа.
- От платёжной платформы к Payment Page направляется информация о результате блокировки.
- Информация о результате блокировки отображается пользователю в веб-сервисе мерчанта на странице с информацией об оплате заказа.
- После того как подтверждается необходимость списания средств, это списание инициируется со стороны веб-сервиса, соответствующий запрос поступает в платёжную платформу и обрабатывается в ней.
- Запрос передаётся в платёжную среду.
- В платёжной среде выполняется обработка платежа.
- Из платёжной среды к платёжной платформе направляется информация о результате списания.
- От платёжной платформы к веб-сервису направляется оповещение о результате списания. Оно автоматически обрабатывается с помощью плагина, благодаря чему в интерфейсе BigCommerce обновляется информация о платеже.
- На стороне веб-сервиса обеспечивается информирование пользователя о результате списания.
Способы открытия платёжной формы
Для взаимодействия с пользователями при проведении одностадийных оплат и блокировке средств в рамках двухстадийных оплат допустимы два способа работы:
Redirected— с открытием платёжной формы в отдельной вкладке браузера (подробнее).Этот способ применяется по умолчанию для всех платёжных методов, при этом для альтернативных методов он выступает единственным возможным способом работы, в то время как для классических карточных платежей можно выбрать и способ
Embedded. В рамках способа работыRedirectedпользователь сначала подтверждает формирование заказа в платформе BigCommerce на странице перехода к оплате веб-сервиса (с помощью кнопки Place Order) и уже после этого указывает необходимые данные в открывшейся платёжной форме и подтверждает формирование платежа в платформе Ecommpay (с помощью кнопки Оплатить).Embedded— со встраиванием платёжной формы непосредственно в интерфейс веб-сервиса (через элемент iframe; подробнее).Этот способ применим только для классических карточных платежей и может быть выбран для них через карточку плагина (подробнее). В рамках этого способа работы в блоке для оплаты с прямым использованием платёжной карты открывается облегчённая редакция платёжной формы Payment Page без отдельной кнопки для подтверждения согласия на оплату, и пользователь может выбрать в такой форме реквизиты платёжной карты (если они были сохранены ранее) или ввести их, а затем — подтвердить готовность провести оплату с помощью кнопки Place Order в пользовательском интерфейсе веб-сервиса. При выборе других платёжных методов в рамках такого способа работы пользователь перенаправляется к платёжной форме в виде отдельной страницы (способом
Redirected).
При работе с этими способами открытия платёжной формы следует учитывать, что некоторые из дополнительных возможностей, в частности возможность повторных попыток проведения платежей, могут быть недоступны при встраивании формы в интерфейс веб-сервиса (со способом Embedded). Вместе с тем другие возможности, как, например, управление языком платёжной формы, применяются в любом случае, независимо от способа открытия формы. За уточнениями о применимости конкретных возможностей в различных случаях можно обращаться к специалистам технической поддержки Ecommpay.
Контроль заказов и платежей
Контролировать информацию о заказах и платежах по ним можно через интерфейс BigCommerce: в подразделе Orders раздела Sales. При этом следует учитывать, что для заказов в веб-сервисе и платежей в платёжной платформе используются разные идентификаторы и статусы. Заказам на стороне веб-сервиса присваиваются порядковые номера (например, 151) и статусы в соответствии с моделью выполнения заказов BigCommerce (подробнее), платежам на стороне платёжной платформы — идентификаторы в виде последовательностей в тридцать два произвольных символа (например, 5876281a-4129-4fad-86ae-f1a24f637c7f) и статусы в соответствии с моделью проведения платежей Ecommpay (подробнее). С вопросами о соответствии статусов заказов и платежей можно обращаться к курирующему менеджеру Ecommpay.
Установка
Чтобы начать работу с плагином Ecommpay Payments для платформы BigCommerce, его необходимо установить. Установка выполняется через каталог плагинов (Apps&Integrations) и административный интерфейс платформы BigCommerce.
- Перейти на страницу плагина в каталоге Apps&Integrations и щёлкнуть кнопку Get this app.
Рис. 7. Страница плагина в каталоге Apps&Integrations
- Выбрать один из предлагаемых вариантов на открывшейся странице — зарегистрироваться в платформе BigCommerce (если это не было сделано ранее) или пройти аутентификацию.
- Щёлкнуть кнопку Download на странице для загрузки плагина Ecommpay Payments в интерфейсе BigCommerce, в подразделе Marketplace раздела Apps.
- Перейти в подраздел My Apps раздела Apps и щёлкнуть кнопку Install на панели плагина.
В результате этих действий осуществляется сетевое подключение веб-сервиса к плагину Ecommpay Payments и на стороне веб-сервиса становится доступна актуальная версия плагина (без необходимости её обновления).
Тестирование
Общая информация
Тестировать работу плагина и проводить тестовые платежи по различным платёжным сценариям без реального списания средств можно через тестовую среду платёжной платформы Ecommpay. Для этого в параметрах работы плагина интерфейса BigCommerce следует указать идентификатор и ключ тестового проекта Ecommpay.Подключиться к платформе можно, заполнив соответствующую форму на основном сайте компании и получив идентификатор и ключ тестового проекта. Также необходимо сообщить специалистам технической поддержки Ecommpay название и адрес веб-сервиса, для которого актуально использование плагина Ecommpay Payments, и валюту проведения платежей, если актуально тестировать проведение платежей в конкретной валюте.
Следует учитывать, что при использовании тестовой среды платёжной платформы Ecommpay плагин подключается к веб-сервису и становится доступен пользователям как вариант оплаты. Поэтому в тех случаях, когда плагин подключается к работающему веб-сервису, рекомендуется выполнять тестирование в период низкой нагрузки и предупреждать пользователей о проводимых работах.
Настройка параметров
Для подготовки к тестированию следует активировать плагин Ecommpay Payments как вариант оплаты в веб-сервисе и настроить параметры его работы. При поддержке группы веб-сервисов это следует делать для каждого веб-сервиса отдельно.
Чтобы активировать плагин в веб-сервисе, следует:
- Перейти к параметрам использования вариантов оплаты в интерфейсе BigCommerce.
Для этого следует выбрать раздел Settings на панели навигации и щёлкнуть строку Payments в секции Setup на открывшейся странице.
- Выбрать один из доступных вариантов оплаты для использования плагина.
Для этого следует раскрыть блок Offline Payment Methods в секции Additional providers и щёлкнуть кнопку Set up в строке подходящего варианта оплаты (Bank Deposit или иного).
Рис. 8. Секция Additional providers в интерфейсе BigCommerce
- Указать значение
Ecommpayв поле Display Name на открывшейся странице и сохранить изменение, щёлкнув кнопку Save.Рис. 9. Страница с параметрами работы варианта оплаты в интерфейсе BigCommerce
Чтобы настроить параметры работы плагина, следует:
- Перейти к параметрам работы плагина в интерфейсе BigCommerce.
Для этого следует выбрать раздел Apps, а затем — пункт Ecommpay Payments на панели навигации.
- Проверить корректность и при необходимости скорректировать основные параметры работы плагина:
- Plugin Enabled — возможность подключить плагин к веб-сервису.
Если переключатель включён, то все платёжные методы, ранее подключённые для работы через плагин, становятся доступными в веб-сервисе. Если переключатель выключен, то все платёжные методы, подключённые для работы через плагин, становятся недоступными для проведения платежей.
- Store Channel — название веб-сервиса мерчанта в платформе BigCommerce (должен быть выбран веб-сервис, для которого задаются параметры работы плагина).
- Mode — возможность установить тестовый режим работы плагина.
Для использования тестового режима работы плагина необходимо задать значение
testи параметры подключения, полученные от Ecommpay, в полях Test Project ID и Test Secret Key. - Test Project ID — идентификатор тестового проекта для взаимодействия с платформой (должен соответствовать полученному от Ecommpay).
- Test Secret Key — ключ тестового проекта (должен соответствовать полученному от Ecommpay).
- Merchant Callback Url — URL для приёма на стороне плагина оповещений от платёжной платформы (формируется и подставляется автоматически при установке плагина Ecommpay Payments).
- Host Url — доменное имя веб-сервиса мерчанта, для которого задаются параметры работы плагина (должно быть указано вручную).
- Payment Mode — вариант проведения оплат через платёжную платформу.
Можно выбрать вариант
Sale(для проведения одностадийных оплат) или вариантAuthorization Only(для проведения двухстадийных оплат). Первый вариант доступен для всех платёжных методов, подключённых для работы через плагин, а второй вариант — только для тех методов, для которых поддерживаются оплаты в две стадии (таких как карточные платежи и методы Apple Pay и Google Pay).Можно выбрать один из следующих вариантов:
Sale— в одну стадию (с незамедлительным списанием средств);Authorization Only— в две стадии (с предварительной блокировкой и последующим списанием средств).
Первый вариант доступен для всех платёжных методов, подключённых для работы через плагин, а второй вариант — только для тех методов, для которых поддерживаются оплаты в две стадии (таких как карточные платежи и методы Apple Pay и Google Pay).
Внимание: Параметры Test Project ID и Test Secret Key обязательны для заполнения. Без их указания тестовый режим работы плагина не поддерживается. - Plugin Enabled — возможность подключить плагин к веб-сервису.
- Задать параметры использования платёжных методов (подробнее).
Проведение тестовых оплат
В рамках работы с плагином можно проводить тестовые оплаты в веб-сервисе и получать информацию о них через интерфейс BigCommerce — в подразделе View раздела Orders. При этом можно использовать специальные платёжные реквизиты, позволяющие тестировать заданные сценарии работы.
Для тестирования карточных платежей по заданным кратчайшим сценариям (без эмулирования аутентификации 3‑D Secure) можно использовать следующие номера карт:
4000 0000 0000 0077— для проведения оплаты;4111 1111 1111 1111— для отклонения оплаты.
Для более масштабного тестирования можно использовать расширенный набор тестовых данных для карточных платежей (подробнее). (в том числе с аутентификацией 3‑D Secure), представленных в статье Номера тестовых карт.
Чтобы тестировать проведение платежей с использованием альтернативных методов (при подключении соответствующих методов через курирующего менеджера или техническую поддержку), можно использовать информацию, представленную в статье Возможности тестирования, а также в соответствующих разделах статей о работе с отдельными методами.
При работе с двухстадийными оплатами первая стадия, блокировка средств, инициируется пользователем при подтверждении им платежа, а вторая, списание заблокированных средств или отмена блокировки, может инициироваться как автоматически, по истечении установленного срока блокировки, так и по запросу со стороны мерчанта. Инициировать вторую стадию со стороны мерчанта можно, через интерфейс BigCommerce или один из интерфейсов платёжной платформы Ecommpay — Dashboard (подробнее) или Gate API (подробнее). При этом, как правило, можно списывать как полную, так и частичную сумму заблокированных средств, хотя для отдельных платёжных методов могут быть доступны только списания полных сумм.
Чтобы инициировать вторую стадию через интерфейс BigCommerce, следует:
- Перейти к реестру заказов в интерфейсе BigCommerce.
Для этого следует открыть подраздел View раздела Orders.
- Открыть панель с данными о двухстадийной оплате в рамках конкретного заказа (через кнопку
в столбце Action).
Для этого следует щёлкнуть кнопку
в поле Action соответствующей строки реестра заказов и выбрать в выпадающем списке пункт
Ecommpay. - Инициировать необходимое действие (с помощью кнопки Capture или Void).
Чтобы инициировать списание заблокированных средств, следует указать сумму для списания и щёлкнуть кнопку Capture в одноимённой секции. Чтобы отменить блокировку средств, следует щёлкнуть кнопку Void в одноимённой секции.
Чтобы настроить автоматическое инициирование второй стадии двухстадийных оплат, следует обращаться к специалистам технической поддержки Ecommpay.
Вместе с тем, если необходимо, чтобы при инициировании второй стадии оплат через интерфейсы платёжной платформы информация о платежах автоматически обновлялась в интерфейсе BigCommerce, следует убедиться, что для используемого проекта настроена отправка оповещений от платёжной платформы на заданный URL веб-сервиса. При этом важно, чтобы для одного типа платежа не было настроено более одного правила отправки оповещений с одинаковыми значениями типа события и кода платёжного метода. Информация о работе с правилами отправки оповещений представлена в соответствующей статье.
Выполнение тестовых возвратов
После проведения тестовых оплат можно тестировать выполнение возвратов через интерфейс BigCommerce, и если актуально, через интерфейсы Dashboard и Gate в платформе Ecommpay. При этом следует учитывать, что для выполнения возвратов платежи на стороне платёжной платформы Ecommpay должны быть в статусах success, partially reversed или partially refunded. Контролировать информацию о возвратах можно через интерфейсы платформы и интерфейс BigCommerce (в реестре заказов).
Чтобы при выполнении тестовых возвратов через интерфейсы платёжной платформы информация о платежах обновлялась автоматически в интерфейсе BigCommerce, необходимо убедиться, что для используемого проекта была настроена отправка оповещений от платёжной платформы на заданный URL. При этом важно, чтобы для одного типа платежа не было настроено несколько правил отправки оповещений с одинаковыми значениями типа события и кода платёжного метода. (URL веб-сервиса отображается на странице с параметрами работы плагина.) Информация о работе с правилами отправки оповещений представлена в соответствующей статье документации.
Чтобы выполнить возврат через интерфейс BigCommerce, следует:
- Перейти к реестру заказов в интерфейсе BigCommerce.
Для этого следует открыть подраздел View раздела Orders.
- Открыть панель с данными о платеже из платёжной платформы (с помощью кнопки
в столбце Action).
Для этого следует щёлкнуть кнопку
в столбце Action и выбрать пункт Ecommpay.
- Инициировать возврат (через секцию Refund на панели с данными о платеже).
Для этого следует указать сумму и причину возврата и щёлкнуть кнопку Refund в соответствующей секции.
- Убедиться в выполнении возврата.
Для этого можно проверить, что на панели с данными о платеже обновилась информация о выполненной операции.
Использование
Общая информация
Для проведения платежей с реальным списанием средств, прежде всего, необходимо решить все организационные вопросы по взаимодействию с Ecommpay (подать заявку на подключение, предоставить всю необходимую информацию и получить от Ecommpay уведомление о возможности проводить платежи, а также идентификатор и секретный ключ рабочего проекта). Также необходимо и сообщить специалистам технической поддержки Ecommpay название и адрес веб-сервиса, для которого актуально использование плагина Ecommpay Payments, и а также валюту проведения платежей.
После этого можно перевести плагин в рабочий режим, указать в параметрах его работы полученные идентификатор и ключ рабочего проекта, полученные от Ecommpay, и задать другие необходимые параметры (или проверить их актуальность для рабочего применения). Если после этого потребуется приостановить работу плагина, например для тестирования при подключении дополнительных функций, его можно перевести в тестовый режим или отключить от веб-сервиса.
Настройка параметров
Для подготовки к работе следует активировать плагин Ecommpay Payments как вариант оплаты в веб-сервисе и настроить параметры его работы. При поддержке группы веб-сервисов это следует делать для каждого веб-сервиса отдельно. При этом следует учитывать, что если плагин был активирован для проведения тестовых оплат, то повторная активация не требуется, но необходимо скорректировать параметры работы плагина (подробнее далее).
Чтобы активировать плагин в веб-сервисе, следует:
- Перейти к параметрам использования вариантов оплаты в интерфейсе BigCommerce.
Для этого следует выбрать раздел Settings на панели навигации и щёлкнуть строку Payments в секции Setup на открывшейся странице.
- Выбрать один из доступных вариантов оплаты для использования плагина.
Для этого следует раскрыть блок Offline Payment Methods в секции Additional providers и щёлкнуть кнопку Set up в строке подходящего варианта оплаты (Bank Deposit или иного).
Рис. 13. Секция Additional providers в интерфейсе BigCommerce
- Указать значение
Ecommpayв поле Display Name на открывшейся странице и сохранить изменение, щёлкнув кнопку Save.Рис. 14. Страница с параметрами работы варианта оплаты в интерфейсе BigCommerce
Чтобы настроить параметры работы плагина, следует:
- Перейти к параметрам работы плагина в интерфейсе BigCommerce.
Для этого следует выбрать раздел Apps, а затем — пункт Ecommpay Payments на панели навигации.
- Проверить корректность и при необходимости скорректировать основные параметры работы плагина:
- Plugin Enabled — возможность подключить плагин к веб-сервису.
- Store Channel — название веб-сервиса мерчанта в платформе BigCommerce (должен быть выбран веб-сервис, для которого задаются параметры работы плагина).
- Mode — режим работы плагина (должен быть выбран вариант
live). - Project ID — идентификатор рабочего проекта для взаимодействия с платформой (должен соответствовать полученному от Ecommpay).
- Secret Key — ключ рабочего проекта (должен соответствовать полученному от Ecommpay).
- Merchant Callback Url — URL для приёма на стороне плагина оповещений от платёжной платформы (формируется и подставляется автоматически при установке плагина Ecommpay Payments).
- Host Url — доменное имя веб-сервиса мерчанта, для которого задаются параметры работы плагина (должно быть указано вручную).
- Payment Mode — вариант проведения оплат через платёжную платформу.
Можно выбрать вариант
Sale(для проведения одностадийных оплат) или вариантAuthorization Only(для проведения двухстадийных оплат). Первый вариант доступен для всех платёжных методов, подключённых для работы через плагин, а второй вариант — только для тех методов, для которых поддерживаются оплаты в две стадии (таких как карточные платежи и методы Apple Pay и Google Pay).Можно выбрать один из следующих вариантов:
Sale— в одну стадию (с незамедлительным списанием средств);Authorization Only— в две стадии (с предварительной блокировкой и последующим списанием средств).
Первый вариант доступен для всех платёжных методов, подключённых для работы через плагин, а второй вариант — только для тех методов, для которых поддерживаются оплаты в две стадии (таких как карточные платежи и методы Apple Pay и Google Pay).
- Задать параметры использования платёжных методов (подробнее).
Проведение оплат
Если веб-сервис и плагин корректно настроены, оплаты проводятся автоматически. При этом важно обеспечивать сбор всех необходимых данных на стороне веб-сервиса.
При работе с двухстадийными оплатами первая стадия, блокировка средств, инициируется пользователем при подтверждении им платежа, а вторая, списание заблокированных средств или отмена блокировки, может инициироваться как автоматически, по истечении установленного срока блокировки, так и по запросу со стороны мерчанта. Инициировать вторую стадию со стороны мерчанта можно, через интерфейс BigCommerce или один из интерфейсов платёжной платформы Ecommpay — Dashboard (подробнее) или Gate API (подробнее). При этом, как правило, можно списывать как полную, так и частичную сумму заблокированных средств, хотя для отдельных платёжных методов могут быть доступны только списания полных сумм.
Чтобы настроить автоматическое инициирование второй стадии двухстадийных оплат, следует обратиться к специалистам технической поддержки Ecommpay.
Чтобы инициировать вторую стадию какой-либо двухстадийной оплаты через интерфейс BigCommerce, следует:
- Перейти к реестру заказов в интерфейсе BigCommerce.
Для этого следует открыть подраздел View раздела Orders.
- Открыть панель с данными о двухстадийной оплате в рамках конкретного заказа (через кнопку
в столбце Action).
Для этого следует щёлкнуть кнопку
в поле Action соответствующей строки реестра заказов и выбрать в выпадающем списке пункт
Ecommpay. - Инициировать необходимое действие (с помощью кнопки Capture или Void).
Чтобы инициировать списание заблокированных средств, следует указать сумму списания и щёлкнуть кнопку Capture в одноимённой секции. Чтобы отменить блокировку средств, следует щёлкнуть кнопку Void в одноимённой секции.
При возникновении вопросов или проблем с проведением оплат можно обращаться к специалистам технической поддержки Ecommpay.
Выполнение возвратов
По оплатам, проведённым с помощью плагина Ecommpay
Payments, можно выполнять частичные и полные возвраты через интерфейс BigCommerce, и если актуально, через интерфейсы Dashboard (с использованием инструментов единичной и пакетной отправки запросов; подробнее) и Gate (подробнее) от Ecommpay. При этом платежи на стороне платформы Ecommpay должны быть в статусах success, partially reversed или partially refunded. После выполнения возвратов всю актуальную информацию о платежах можно контролировать через интерфейс BigCommerce и интерфейсы платёжной платформы.
Чтобы выполнить возврат через интерфейс BigCommerce, следует:
- Перейти к реестру заказов в интерфейсе BigCommerce.
Для этого следует открыть подраздел View раздела Orders.
- Открыть панель с данными о платеже из платёжной платформы (с помощью кнопки
в столбце Action).
Для этого следует щёлкнуть кнопку
в столбце Action и выбрать пункт Ecommpay.
- Инициировать возврат (через секцию Refund на панели с данными о платеже).
Для этого следует указать сумму и причину возврата и щёлкнуть кнопку Refund в соответствующей секции.
- Убедиться в выполнении возврата.
Для этого можно проверить, что на панели с данными о платеже обновилась информация о выполненной операции.
Контроль платежей и заказов
Контролировать информацию о платежах, проводимых с помощью плагина Ecommpay Payments, а также о соответствующих заказах можно через интерфейс BigCommerce, используя инструменты подраздела View в разделе Orders.
Также для получения информации можно использовать интерфейс Dashboard от Ecommpay (подробнее), в котором доступна информация о платежах и возвратах, проводимых через платформу Ecommpay, но не отображается информация о заказах.
В подразделе View раздела Orders отображается реестр заказов, в котором доступны различные возможности работы с заказами, а также возможность получать информацию о платежах в рамках отдельных заказов.
В подразделе View раздела Orders отображается реестр заказов с информацией о каждом из них. Наряду с этим в реестре доступны различные функции для работы с заказами, в том числе через него можно выполнять поиск и фильтрацию заказов, а также получать информацию о платежах в рамках отдельных заказов.
Щёлкнув кнопку
в соответствующем столбце реестра, можно раскрыть блок с более развёрнутыми сведениями о конкретном заказе.Для получения развёрнутых сведений о конкретном заказе можно щёлкнуть кнопку
в соответствующем столбце реестра. В раскрывающемся блоке отображается такая информация, как расчётный адрес пользователя, дата создания и сумма заказа и другие сведения.
В секции Billing раскрывающегося блока отображается название организации, через которую проводится платёж, с названием платёжного метода (в поле с иконкой
) и идентификатор платежа (в поле с иконкой
). Для получения более детальной информации о платеже следует щёлкнуть кнопку в столбце Action и пункт Ecommpay в выпадающем списке. На открывшейся панели отображается секция Order Details с информацией о платеже и могут отображаться следующие секции (если соответствующие функции доступны в рамках выбранного заказа):
- Capture — с возможностью инициировать списание заблокированных средств в рамках двухстадийной оплаты;
- Void — с возможность отменить блокировку средств в рамках двухстадийной оплаты;
- Refund — с возможностью инициировать возврат средств в рамках оплаты.
Более подробная информация о работе с заказами в интерфейсе BigCommerce представлена в документации BigCommerce.
Параметры использования платёжных методов
При работе с плагином Ecommpay Payments в интерфейсе BigCommerce можно настраивать параметры использования различных платёжных методов, подключённых в рамках проекта мерчанта. Это можно делать через отдельные раскрывающиеся блоки на странице с параметрами работы плагина, задавая следующие параметры: — Card Payments (с параметрами для классических карточных платежей) и Alternative payment settings (с вложенными блоками параметров для заданной группы альтернативных платёжных методов и дополнительным блоком параметров More payment methods для всех методов, подключённых в рамках проекта).
В раскрывающихся блоках для настройки использования платёжных методов можно задавать следующие параметры:
- Общие параметры:
- Enabled — доступность платёжного метода для проведения платежей при использовании плагина.
- Title — название платёжного метода, отображаемое на странице перехода к оплате в веб-сервисе.
- Description — пояснительное описание к методу для его отображения в интерфейсе веб-сервиса.
- Show Description — необходимость отображения пояснительного описания к методу (из параметра Description) в интерфейсе веб-сервиса.
- Параметр, актуальный только для блока Card payments:
- Display mode — способ открытия платёжной формы Payment Page, в качестве которого можно выбрать один из следующих вариантов:
Redirected— открытие в виде отдельной HTML-страницы (применяется по умолчанию).Embedded— открытие в элементе iframe.
При выборе варианта
Embeddedпараметры Description и Show Description в блоке для карточных платежей не используются, поскольку при открытии платёжной формы таким способом пользователю отображается облегчённая редакция платёжной формы Payment Page в списке вариантов для оплаты (подробнее).Рис. 20. Раскрывающийся блок с параметрами для карточных платежей в интерфейсе BigCommerce
- Display mode — способ открытия платёжной формы Payment Page, в качестве которого можно выбрать один из следующих вариантов:
- Параметр, актуальный только для блока More payment methods:
- Payment method code — код платёжного метода, используемого как единственный дополнительный (по отношению к методам, для настройки работы с которыми применяются отдельные раскрывающиеся блоки).
- Если не применять этот параметр, то при выборе способа оплаты в интерфейсе веб-сервиса пользователь может выбрать вариант More payment methods и перейти к платёжной форме с возможностью выбрать там любой из методов, доступных для инициируемого платежа через платформу Ecommpay. При этом все методы от Ecommpay, доступные для выбора непосредственно в веб-сервисе (наряду с вариантом More payment methods), оказываются доступными и в платёжной форме.
- Если указать в значении этого параметра код одного из доступных методов (в соответствии со справочником), то при выборе способа оплаты в интерфейсе веб-сервиса наряду с другими доступными там для выбора методами пользователь может выбрать указанный метод и перейти к работе с ним, минуя выбор каких-либо других методов в платёжной форме. Чтобы не допускать коллизий с таким выбором, при указании кода какого-либо метода в этом разделе также следует указывать название этого метода для отображения в веб-сервисе (в поле Title).
Рис. 21. Раскрывающийся блок с параметрами для блока More payment methods в интерфейсе BigCommerce - Payment method code — код платёжного метода, используемого как единственный дополнительный (по отношению к методам, для настройки работы с которыми применяются отдельные раскрывающиеся блоки).