Top.Mail.Ru
Документация по интеграции плагина Яндекс Пэй + Сплит с WordPress и WooCommerce

Время чтения: ~7 мин.

Время на интеграцию плагина: ~15 мин.


Добро пожаловать в документацию нашего плагина! Данный плагин разработан нашей командой для легкой и быстрой интеграции платежной системы Яндекс Пэй и Сплит c WordPress. В следующих разделах вы найдете подробную информацию о функциях системы, процессе интеграции и использовании плагина.

Плагин протестирован и совместим с версиями:
WordPress 5.7 - WordPress 6.6.2
WooCommerce 8.3 - WooCommerce 9.2.3

PHP 7.2 - PHP 8.1.0


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

Личный кабинет
Создание личного кабинета

Для интеграции плагина на ваш сайт вам необходимо выполнить следующие шаги:
  1. Зайдите на наш официальный сайт на страницу WordPress.
  2. Найдите и нажмите кнопку «Интегрировать».
  3. Заполните все необходимые поля.
  4. После подтверждения оплаты, вы получите доступ к скачиванию плагина и лицензионный ключ активации.
Добавление домена

Домен сайта добавится автоматически, если вы заполнили форму интеграции на нашем сайте.

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

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

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

Стоимость интеграции плагина — 5 990₽.

После оплаты вы получите лицензионный ключ активации плагина в вашем личном кабинете.
Этот ключ необходим для полноценного функционирования плагина на вашем сайте.
Оплата осуществляется единоразово и предоставляет право на интеграцию плагина.
Лицензионный ключ

Лицензионный ключ играет важную роль в активации плагина на вашем сайте.

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

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

Вам доступны следующие функции:
  • Встроенный режим тестирования — возможность проведения тестовой оплаты.
  • Подключение полной оплаты с Яндекс Пэй и частями в Сплит.
  • Кастомизация внешнего вида и расположения бейджиков и виджета.
  • Динамическое обновление статусов оплаты и возврата заказа.
  • Оформление полного и частичного возврата в интерфейсе управления заказами.
  • Поддержка Callback-уведомлений.
  • Отмена платежа.
  • Изменение названия выбора платежной системы на странице оплаты.
  • Возможность добавления бейджиков и виджетов Яндекс Пэй и Сплит с помощью шорткодов.
Авторизация в Яндекс Пэй

  1. Авторизуйтесь в личном кабинете Яндекс Пэй по шагам в разделе Регистрация.
  2. В личном кабинете на вкладке Сервисы заполните данные о вашем магазине и оставьте заявку на подключение сервиса.
  3. Перейдите в раздел Настройки в кабинете Яндекс Пэй.
  4. В блоке Как можно оплатить заказ на сайте выберите опцию Яндекс Пэй со Сплитом: полные оплаты и оплаты частями. Подробнее читайте в инструкции.
  5. Включите опцию Тестовая среда.
  6. Запишите Merchant ID и тестовый API-key для тестирования интеграции с WordPress.
Интеграция плагина

Скачивание плагина станет доступно после оплаты.

Чтобы интегировать плагин, выполните следующие шаги:
  1. Скачайте архив с плагином из вашего личного кабинета
  2. Перейдите в раздел Плагины -> Добавить плагин и загрузите скачанный архив плагина в вашу систему.
  3. Перейдите в раздел Плагины -> Установленные и активируйте плагин.
  4. В настройках плагина введите ваш лицензионный ключ из личного кабинета и нажмите «Проверить».
  5. После проверки ключа активации настройте платежную систему и протестируйте оплату на сайте.

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

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

Для проверки плагина выполните следующие шаги:
  1. Включите режим Тестовая среда в Настройках Яндекс Пэй.
  2. В Тестовой среде в поле Callback URL укажите значение - "https://domain.com/?yandex_pay_split=callback", где «domain.com» это доменное имя вашего сайта. Нажмите кнопку «Сохранить».
  3. Скопируйте тестовые данные Merchant ID и тестовый API-key из настроек магазина Яндекс Пэй. Далее в настройках плагина добавьте тестовые данные и включите Режим тестовой среды. Нажмите «Сохранить изменения».
  4. Добавьте товары в корзину на вашем сайте и выберите способ оплаты Яндекс Пэй или Сплит.
  5. Оформите и оплатите заказ. Для оплаты используется тестовая карта.
Боевой режим

Боевой режим необходим для того, чтобы после успешного тестирования вы могли начать принимать реальные платежи на вашем сайте.

Для включения боевого режима выполните следующие шаги:
  1. Перейдите в раздел Настройки Яндекс Пэй и отключите режим Тестовая среда.
  2. В Боевом режиме в поле Callback URL укажите значение - "https://domain.com/?yandex_pay_split=callback", где «domain.com» это доменное имя вашего сайта. Нажмите «Сохранить».
  3. Скопируйте боевые данные Merchant ID и API-key из настроек магазина Яндекс Пэй. Далее в настройках плагина добавьте боевые данные и отключите Режим тестовой среды. Нажмите «Сохранить изменения».
  4. После перехода в боевой режим оплата с помощью Яндекс Пэй и Сплит будет доступна на сайте для покупателей.

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

MERCHANT_ACCOUNT_ERROR
Если вы столкнулись с ошибкой "MERCHANT_ACCOUNT_ERROR", проверьте шаги переключения вашего магазина с тестовых данных на боевые. В настройках плагина добавьте боевые данные Merchant ID и API-key в соответствующие поля и отключите галочку Режим тестовой среды.
Убедитесь, что в консоли Яндекс Пэй в разделе Магазины ваш сайт находится в статусе "Подключен".

В случае возникновения других ошибок, пожалуйста, обратитесь в нашу службу технической поддержки.
Бейджики и виджет

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

Бейджики появятся, когда ваша заявка на подключение в личном кабинете Яндекс Пэй будет рассмотрена и ваш магазин перейдет в статус "Подключен".

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

Чтобы активировать отображение бейджиков, перейдите в настройки плагина и найдите соответствующую опцию:
  1. Включите отображение и настройте параметры внешнего вида Бейджиков для каталога товаров в настройках плагина. Для применения настроек нажмите кнопку «Сохранить изменения».
  2. Включите отображение и настройте параметры внешнего вида Виджетов для карточек товаров в настройках плагина. Для применения настроек нажмите кнопку «Сохранить изменения».
Шорткоды

Плагин предоставляет возможность добавления бейджиков и виджетов Яндекс Пэй и Яндекс Сплит с помощью шорткодов.

Шорткоды бейджиков.
1. [yps_cashback] — Бейджик с информацией о кэшбэке.
2. [yps_split] — Бейджик с информацией Яндекс Сплит.

Параметры шорткодов.
Общие параметры:
  • sum (целое число) — Сумма, отображаемая на бейджике.
  • product_id (целое число) — ID товара для получения и отображения соответствующего бейджика.
  • class (строка) — CSS-класс элемента для стилизации.

Параметры бейджиков:
Примеры использования шорткодов.

Бейджик для кэшбэка:
[yps_cashback sum="1500" size="m" theme="light" variant="default" color="primary" class="custom-class"]

Бейджик для разделения платежа:
[yps_split sum="2000" product_id="123" size="l" theme="dark" variant="detailed" color="green" class="custom-split"]

Бейджик с компактным отображением кэшбэка:
[yps_cashback product_id="456" size="s" theme="light" variant="compact" color="grey" class="cashback-badge"]

Бейджик для товара с ID:
[yps_split product_id="789" size="m" theme="dark" color="transparent"]

Интеграция в PHP-код.
Для использования шорткодов в PHP-коде воспользуйтесь функцией do_shortcode.
Пример:
echo do_shortcode('[yps_cashback sum="1500" size="m" theme="light"]');

Шорткод виджета.
Шорткод [yps_widget] используется для вывода стандартного виджета Яндекс Сплит.
Этот виджет получает настройки из раздела "Виджеты" в настройках плагина.

Пример использования:
Просто добавьте шорткод в любом месте вашего сайта:
[yps_widget]
После добавления виджет автоматически появится и начнет работать без дополнительной настройки.
Полные и частичные возвраты

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

Внимание! Возврат осуществляется не по сумме, а по количеству товаров.

Вы можете сделать полный возврат одного товара или частичный возврат, если товаров одного наименования в заказе несколько. Также вы можете сделать возврат всего заказа, сделав полный возврат одного или нескольких наименований товара в составе заказа.

Для того чтобы сделать полный или частичный возврат товаров, перейдите в панель WordPress.

Далее -> WooCommerce -> Заказы -> Выберите в списке нужный заказ -> Нажмите кнопку “Возврат” -> Укажите необходимое количество товаров для возврата.

Изменение названия платежной системы

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

Далее -> WooCommerce -> Настройки -> Платежи -> Найдите в списке платежных систем Яндекс Пэй и Сплит -> нажмите кнопку «Управление».

После внесения необходимых изменений, нажмите кнопку «Сохранить изменения».
Результат отобразится на странице оформления заказа.