Использование плагина ecommpay Payments для BigCommerce

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

Плагин ecommpay Payments устанавливается через каталог плагинов Apps&Integrations и административный интерфейс BigCommerce, позволяет открывать пользователям платёжную форму Payment Page от ecommpay и обеспечивать все необходимые действия для проведения платежей, как в части взаимодействия с пользователями, так и в части взаимодействия с платёжной платформой ecommpay, с передачей и приёмом всей необходимой информации.

Технически плагин разворачивается в платёжной платформе ecommpay и взаимодействие веб-сервиса с плагином строится через сетевое подключение к нему. Таким образом, на стороне веб-сервиса всегда используется актуальная версия плагина.

Рис.: Административный интерфейс BigCommerce

Рис.: Интерфейс платёжной формы Payment Page

Возможности

При использовании плагина ecommpay Payments можно:

• Оперативно встраивать в веб-сервис возможность вызова платёжной формы Payment Page от ecommpay.

  Для этого достаточно всего нескольких действий в интерфейсе BigCommerce.

• Настраивать использование различных платёжных методов, доступных для работы через плагин.

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

• Тестировать работу платёжной формы и возможности проведения платежей.

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

• Проводить разовые оплаты в одну и две стадии.

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

• Выполнять частичные и полные возвраты средств по оплатам, проведённым с помощью плагина.

  Для этого можно использовать интерфейс BigCommerce и, если актуально, интерфейсы платёжной платформы ecommpay (пользовательский интерфейс Dashboard и Gate API). Вместе с тем, при использовании интерфейсов платёжной платформы ecommpay информация о платежах в интерфейсе BigCommerce обновляется, только если настроена отправка оповещений со стороны платёжной платформы (подробнее).

• Контролировать информацию о платежах, проводимых с помощью плагина.

  Для этого можно использовать интерфейс BigCommerce и, если актуально, — интерфейс Dashboard от ecommpay.

• Управлять заказами, оплаты по которым проводятся с помощью плагина, через интерфейс BigCommerce.

  При этом можно отменять и удалять такие заказы и корректировать их статусы вручную. Также следует учитывать, что автоматическое изменение статусов заказов при работе с плагином ecommpay Payments не предусмотрено, но может быть настроено специалистами мерчанта с использованием возможностей платформы BigCommerce, а также собственных или сторонних решений.

• Настраивать способ открытия платёжной формы Payment Page, адаптируя её под специфику веб-сервиса, и применять различные возможности, обеспечиваемые со стороны ecommpay.

  При работе с плагином ecommpay Payments для платёжной формы можно использовать большинство её дополнительных возможностей (подробнее), за исключением отдельных, таких как проведение оплат по токенам. В частности, можно применять процедуру подтверждения зачислений при работе с платёжными методами Open Banking, делать доступными для пользователей повторные попытки оплаты (подробнее) и подключать отправку пользователям уведомлений о результатах оплат (подробнее). Для подключения таких возможностей следует обращаться к специалистам технической поддержки ecommpay.

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

Схемы работы

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

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

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

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

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

• со встраиванием платёжной формы непосредственно в интерфейс веб-сервиса (через элемент iframe);
• с открытием платёжной формы в отдельной вкладке.

Первый из этих вариантов доступен только для оплат с прямым использованием платёжных карт и используется для них по умолчанию. В первом этом варианте пользователь указывает данные платёжной карты и подтверждает формирование заказа в платформе BigCommerce и платежа в платформе ecommpay непосредственно на странице перехода к оплате в веб-сервисе (с помощью кнопки Place Order).

Второй вариант используется для альтернативных платёжных методов и для оплат с прямым использованием платёжных карт, если для них был выбран способ открытия формы в отдельной вкладке. Во втором В этом варианте пользователь сначала подтверждает переход к оплате (с помощью кнопки Place Order в веб-сервисе) и уже после этого указывает необходимые данные в открывшейся платёжной форме и подтверждает формирование заказа в платформе BigCommerce и платежа в платформе ecommpay (с помощью кнопки Оплатить).

Вместе с тем, следует учитывать ряд особенностей:

• Независимо от выбранного варианта открытия Payment Page, язык платёжной формы определяется в соответствии с заданным порядком работы (подробнее).
• Если для проекта подключена возможность повторных попыток проведения платежей, следует использовать вариант работы с открытием платёжной формы Payment Page в отдельной вкладке. Для варианта работы со встраиванием формы в интерфейс веб-сервиса не поддерживается возможность перехода к повторной попытке непосредственно из формы.
• Для заказов в веб-сервисе и платежей в платёжной платформе используются разные идентификаторы и статусы. Заказам на стороне веб-сервиса присваиваются порядковые номера (например, 151) и статусы в соответствии с моделью выполнения заказов BigCommerce (подробнее), платежам на стороне платёжной платформы — идентификаторы в виде кодов из тридцати двух случайных символов (например, 5876281a-4129-4fad-86ae-f1a24f637c7f), и статусы в соответствии с моделью проведения платежей ecommpay (подробнее). С вопросами о соответствии статусов заказов и платежей можно обращаться к курирующему менеджеру ecommpay.

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

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

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

Для подготовки к тестированию следует активировать плагин ecommpay Payments как вариант оплаты в веб-сервисе и настроить параметры его работы.

Чтобы активировать плагин в веб-сервисе, следует:

1. Перейти к параметрам вариантов оплаты в интерфейсе BigCommerce.

   Для этого следует выбрать раздел Settings на панели навигации и щёлкнуть строку Payments в секции Setup на открывшейся странице.

2. Выбрать вариант оплаты для активации плагина.

   Для этого следует раскрыть блок Offline Payment Methods в секции Additional providers и щёлкнуть кнопку Set up в строке любого из вариантов оплаты (Bank Deposit или иного подходящего).

   Рис.: Секция Additional providers в интерфейсе BigCommerce

   

3. Указать с заглавной буквы значение Ecommpay в поле Display Name на открывшейся странице и сохранить изменение.

   Рис.: Страница с параметрами работы варианта оплаты в интерфейсе BigCommerce

   

Чтобы настроить параметры работы плагина, следует:

1. Перейти к параметрам работы плагина в интерфейсе BigCommerce.

   Для этого следует выбрать раздел Apps, а затем — пункт ecommpay Payments на панели навигации.

2. Убедиться, что на открывшейся странице заданы основные параметры работы плагина, и при необходимости задать их:
   • Plugin Enabled — доступность платёжных методов в веб-сервисе (должна быть включена).

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

   • Mode — режим работы плагина (должен быть выбран вариант test).
   • 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.

3. Задать параметры использования платёжных методов (подробнее).

Рис.: Секция с основными параметрами работы плагина в интерфейсе BigCommerce

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

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

Для тестирования карточных платежей по заданным кратчайшим сценариям (без эмулирования аутентификации 3‑D Secure) можно использовать следующие номера карт:

• 4000 0000 0000 0077 — для проведения оплаты;
• 4111 1111 1111 1111 — для отклонения оплаты.

Для более масштабного тестирования можно использовать расширенный набор тестовых данных для карточных платежей (подробнее). (в том числе с аутентификацией 3‑D Secure), представленных в статье Тестовые карты.

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

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

Чтобы инициировать вторую стадию через интерфейс BigCommerce, следует:

1. Перейти к реестру заказов в интерфейсе BigCommerce.

   Для этого следует открыть подраздел View раздела Orders.

2. Открыть панель с данными о двухстадийной оплате в рамках конкретного заказа (через кнопку в столбце Action).

   Для этого следует щёлкнуть кнопку в столбце Action реестра заказов и выбрать пункт ecommpay в выпадающем списке.

3. Инициировать необходимое действие на панели (в секции Capture или Void).

   Чтобы инициировать списание заблокированных средств, следует указать сумму для списания и щёлкнуть кнопку Capture в соответствующей секции. Чтобы отменить блокировку средств, следует щёлкнуть кнопку Void в соответствующей секции.

Рис.: Панель с секциями Capture и Void в реестре заказов интерфейса BigCommerce

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

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

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

После проведения тестовых оплат можно тестировать выполнение возвратов через интерфейс BigCommerce, и если актуально, через интерфейсы Dashboard и Gate в платформе ecommpay. При этом следует учитывать, что для выполнения возвратов платежи на стороне платёжной платформы ecommpay должны быть в статусах success, partially reversed или partially refunded. Контролировать информацию о возвратах можно через интерфейсы платформы и интерфейс BigCommerce (в реестре заказов).

Чтобы при выполнении тестовых возвратов через интерфейсы платёжной платформы информация о платежах обновлялась автоматически в интерфейсе BigCommerce, необходимо убедиться, что для используемого проекта была настроена отправка оповещений от платёжной платформы на заданный URL. При этом важно, чтобы для одного типа платежа не было настроено насколько правил отправки оповещений с одинаковыми значениями типа события и кода платёжного метода. (URL веб-сервиса отображается на странице с параметрами работы плагина.) Информация о работе с правилами отправки оповещений представлена в соответствующей статье документации.

Чтобы выполнить возврат через интерфейс BigCommerce, следует:

1. Перейти к реестру заказов в интерфейсе BigCommerce.

   Для этого следует открыть подраздел View раздела Orders.

2. Открыть панель с данными о платеже из платёжной платформы (с помощью кнопки в столбце Action).

   Для этого следует щёлкнуть кнопку в столбце Action и выбрать пункт ecommpay.

3. Инициировать возврат (через секцию Refund на панели с данными о платеже).

   Для этого следует указать сумму и причину возврата и щёлкнуть кнопку Refund в соответствующей секции.

4. Убедиться в выполнении возврата.

   Для этого можно проверить, что на панели с данными о платеже обновилась информация о выполненной операции.

Рис.: Панель с секцией Refund в реестре заказов интерфейса BigCommerce

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

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

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

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

Для подготовки к плагина к работе следует активировать плагин ecommpay Payments как вариант оплаты в веб-сервисе и настроить параметры его работы.

Чтобы активировать плагин в веб-сервисе, следует:

1. Перейти к параметрам вариантов оплаты в интерфейсе BigCommerce.

   Для этого следует выбрать раздел Settings на панели навигации и щёлкнуть строку Payments в секции Setup на открывшейся странице.

2. Выбрать вариант оплаты для активации плагина.

   Для этого следует раскрыть блок Offline Payment Methods в секции Additional providers и щёлкнуть кнопку Set up в строке любого из вариантов оплаты (Bank Deposit или иного подходящего).

   Рис.: Секция Additional providers в интерфейсе BigCommerce

   

3. Указать с заглавной буквы значение Ecommpay в поле Display Name на открывшейся странице и сохранить изменение.

   Рис.: Страница с параметрами работы варианта оплаты в интерфейсе BigCommerce

   

Чтобы настроить параметры работы плагина, следует:

1. Перейти к параметрам работы плагина в интерфейсе BigCommerce.

   Для этого следует выбрать раздел Apps, а затем — пункт ecommpay Payments на панели навигации.

2. Убедиться, что на открывшейся странице заданы основные параметры работы плагина, и при необходимости задать их:
   • Plugin Enabled — доступность платёжных методов в веб-сервисе (должна быть включена).

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

   • 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.

3. Задать параметры использования платёжных методов (подробнее).

Рис.: Секция с основными параметрами работы плагина в интерфейсе BigCommerce

Выполнение возвратов

По оплатам, проведённым с помощью плагина ecommpay Payments, можно выполнять частичные и полные возвраты через интерфейс BigCommerce, и если актуально, через интерфейсы Dashboard (с использованием инструментов единичной и пакетной отправки запросов; подробнее) и Gate (подробнее) от ecommpay. При этом платежи на стороне платформы ecommpay должны быть в статусах success, partially reversed или partially refunded. После выполнения возвратов всю актуальную информацию о платежах можно контролировать через интерфейс BigCommerce и интерфейсы платёжной платформы.

Чтобы выполнить возврат через интерфейс BigCommerce, следует:

1. Перейти к реестру заказов в интерфейсе BigCommerce.

   Для этого следует открыть подраздел View раздела Orders.

2. Открыть панель с данными о платеже из платёжной платформы (с помощью кнопки в столбце Action).

   Для этого следует щёлкнуть кнопку в столбце Action и выбрать пункт ecommpay.

3. Инициировать возврат (через секцию Refund на панели с данными о платеже).

   Для этого следует указать сумму и причину возврата и щёлкнуть кнопку Refund в соответствующей секции.

4. Убедиться в выполнении возврата.

   Для этого можно проверить, что на панели с данными о платеже обновилась информация о выполненной операции.

Рис.: Панель с секцией Refund в реестре заказов интерфейса BigCommerce

Контроль платежей и заказов

Контролировать информацию о платежах, проводимых с помощью плагина ecommpay Payments, а также о соответствующих заказах можно через интерфейс BigCommerce, используя инструменты подраздела View в разделе Orders.

Также для получения информации можно использовать интерфейс Dashboard от ecommpay (подробнее), в котором доступна информация о платежах и возвратах, проводимых через платформу ecommpay, но не отображается информация о заказах.

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

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

Рис.: Реестр заказов в интерфейсе BigCommerce

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

Рис.: Раскрывающийся блок с информацией о заказе в интерфейсе BigCommerce

В секции Billing раскрывающегося блока отображается название организации, через которую проводится платёж, с названием платёжного метода (в поле с иконкой ) и идентификатор платежа (в поле с иконкой ). Для получения более детальной информации о платеже следует щёлкнуть кнопку в столбце Action и пункт ecommpay в выпадающем списке. На открывшейся панели отображается секция Order Details с информацией о платеже и могут отображаться следующие секции (если соответствующие функции доступны в рамках выбранного заказа):

• Capture — с возможностью инициировать списание заблокированных средств в рамках двухстадийной оплаты;
• Void — с возможность отменить блокировку средств в рамках двухстадийной оплаты;
• Refund — с возможностью инициировать возврат сресдств в рамках оплаты.

Рис.: Панель с секцией Order Details в интерфейсе BigCommerce

Более подробная информация о работе с заказами в интерфейсе BigCommerce представлена в документации BigCommerce.