VibeFox Ozow for WooCommerce — Помощь

Требования

WordPress: 6.2 или новее.

WooCommerce: 8.0 или новее, установлен и активен. Плагин не активируется без него.

PHP: 8.0 или новее.

Валюта: южноафриканский ранд (ZAR). Способ оплаты скрывается для других валют. Ozow принимает суммы в целых центах, поэтому WooCommerce должен использовать 2 знака после запятой.

Учётная запись Ozow: учётная запись мерчанта Ozow с Site Code и Private Key вашего сайта Ozow, которые берутся в личном кабинете мерчанта Ozow. API Key необязателен, но рекомендуется. Ozow использует одинаковые Site Code и ключи для тестовых и боевых платежей.

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

Лицензионный ключ VibeFox: покупается на vibefox.net. Один ключ работает на одном домене.

Установка

1. В WordPress откройте Plugins > Add New > Upload Plugin, выберите ZIP-архив плагина и нажмите Install Now. Также можно загрузить папку wcp_ozow_pay в /wp-content/plugins/ по FTP.

2. Нажмите Activate.

3. Откройте настройки: WooCommerce > Settings > Payments > Ozow > Manage или нажмите Settings под названием плагина на странице Plugins.

4. Введите лицензионный ключ VibeFox в блок лицензии вверху страницы и нажмите Activate.

5. Введите Site Code и Private Key, а желательно и API Key из личного кабинета мерчанта Ozow.

6. Включите Enable/Disable. Совершите тестовый платёж при включённом Test mode, затем выключите тестовый режим, чтобы принимать реальные платежи.

Настройка

Все настройки находятся на одной странице: WooCommerce > Settings > Payments > Ozow. Над полями страница предупреждает, если не указаны Site Code или Private Key (тогда Ozow скрыт при оформлении заказа), если валюта магазина не ZAR и если WooCommerce использует больше 2 знаков после запятой. Пока включён тестовый режим, она также показывает Test mode is on: no real payments are accepted. Do not ship orders paid in test mode. В списке способов оплаты Ozow помечен как требующий настройки, пока не заполнены Site Code и Private Key.

Общие

Enable/Disable: Enable Ozow payments включает или выключает способ оплаты. По умолчанию: выключено.

Title: название способа оплаты, которое видят покупатели при оформлении заказа. По умолчанию: Instant EFT (Ozow).

Description: текст под способом оплаты при оформлении заказа. По умолчанию: Pay instantly and securely from your South African bank account. You will be redirected to Ozow to choose your bank and approve the payment. В тестовом режиме под ним добавляется строка TEST MODE: no money will be charged.

Учётные данные Ozow

Скопируйте Site Code, Private Key и API Key из личного кабинета мерчанта Ozow (Merchant details / Sites). В разделе есть ссылка на документацию по интеграции Ozow на hub.ozow.com.

Site Code: Site Code сайта Ozow, который получает платежи. Ответы для другого Site Code отклоняются.

Private Key: подписывает каждый запрос на оплату и проверяет каждый ответ Ozow. Храните его в секрете. Без него способ оплаты скрыт и ни один ответ Ozow не принимается.

API Key (recommended): необязательно. С API Key каждый успешный платёж дополнительно подтверждается через Ozow GetTransaction API, прежде чем заказ будет отмечен оплаченным. API должен сообщить, что платёж завершён, для этого заказа, с той же суммой, валютой и Site Code.

Test mode: Enable Ozow test mode. Ozow использует для тестов тот же Site Code и те же ключи: платежи создаются с IsTest=true, и деньги не переводятся. Заказы, оплаченные в тестовом режиме, получают примечание; не отправляйте их. Выключите тестовый режим, чтобы принимать реальные платежи. Тестовый платёж никогда не оплачивает заказ в боевом режиме. По умолчанию: включено.

Уведомления об оплате

URL уведомления, успешного платежа, отмены и ошибки передаются в Ozow с каждым платежом, поэтому в личном кабинете Ozow ничего настраивать не нужно, если только ваш сайт Ozow не настроен на фиксированные URL. В разделе показан URL уведомления. Он выглядит так: https://your-site/wc-api/ozow_pay/?ozow_notify=1. Если ваш сайт Ozow использует фиксированные URL, скопируйте его точно в том виде, в каком он показан в настройках.

Дополнительно

Debug log: Log payment requests and Ozow responses записывает подробности в WooCommerce > Status > Logs, источник wcp_ozow_pay. Ошибки и предупреждения записываются всегда. Ключи, хеши и данные покупателей никогда не записываются. По умолчанию: выключено.

Delete data on uninstall: Remove the settings and logs of this plugin when it is deleted (Ozow data saved on orders is kept). По умолчанию: выключено.

Оформление заказа

Покупатель выбирает способ оплаты (по умолчанию Instant EFT (Ozow)) и оформляет заказ. Плагин перенаправляет покупателя на размещённую страницу оплаты Ozow с подписанным запросом на сумму заказа в ZAR. Ссылка в банковской выписке: Order и номер заказа (до 20 латинских букв, цифр, пробелов и дефисов). Имя покупателя передаётся в Ozow. На странице Ozow покупатель выбирает южноафриканский банк и подтверждает платёж в банковском приложении.

Затем Ozow уведомляет магазин и возвращает покупателя. Оба запроса содержат одинаковый подписанный ответ и обрабатываются одинаково, поэтому заказ обновляется, даже если один из них потерян. Заказ отмечается оплаченным только после подтверждения Ozow: хеш должен быть проверен вашим Private Key, Site Code должен быть вашим, ответ должен содержать ключ этого заказа, а сумма и валюта должны совпадать с заказом. С API Key платёж дополнительно проверяется через GetTransaction API.

После успешной оплаты покупатель попадает на страницу «Заказ получен». Если Ozow ещё не подтвердил платёж, страница сообщает: We are waiting for Ozow to confirm your payment. You will receive an e-mail as soon as it is confirmed — there is no need to pay again. Если заказ на удержании, там будет написано: Your Ozow payment was received and is being reviewed by the store. We will contact you if anything is needed.

Если покупатель отменяет платёж на странице Ozow или платёж не удаётся, заказ переходит в статус «Неудавшийся», а покупатель возвращается на страницу Pay for order с сообщением The Ozow payment was cancelled. You can try again or choose another payment method. или The Ozow payment was not completed. You can try again or choose another payment method. Покупатель может оплатить тот же заказ повторно.

Способ оплаты работает в классическом оформлении заказа, в блоке «Оформление заказа» и на странице Pay for order (только для заказов в ZAR). Он совместим с WooCommerce High-Performance Order Storage (HPOS).

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

Заказы

Статусы заказов

Pending payment: покупатель был отправлен в Ozow и ещё не оплатил или Ozow ещё не подтвердил платёж.

Processing: платёж подтверждён. Это стандартный статус WooCommerce после оплаты; заказы, содержащие только виртуальные скачиваемые товары, переходят в статус «Выполнен». В примечании к заказу указаны сумма и ID транзакции Ozow, а также подтверждён ли платёж через GetTransaction API. ID транзакции заказа — это TransactionId Ozow. Тестовый платёж получает примечание TEST MODE — no money was received, do not ship this order.

On hold: причина указана в примечании к заказу. Ozow или банк проверяет платёж (заказ обновится, когда Ozow пришлёт окончательный статус); оплаченная сумма или валюта не совпадает с заказом; платёж пришёл по уже отменённому заказу; либо, с API Key, GetTransaction API ещё не смог подтвердить платёж или противоречит ему. Проверьте платёж в личном кабинете Ozow и измените статус заказа. Если API не смог ответить, следующее уведомление Ozow завершит заказ.

Failed: покупатель отменил платёж, платёж был прерван или Ozow сообщил об ошибке. Покупатель может оплатить заказ повторно.

Уже оплаченный заказ никогда не возвращается назад, а отменённый или возвращённый заказ никогда не открывается повторно. Если для уже оплаченного заказа приходит второй платёж, примечание просит вас вернуть дубликат в личном кабинете Ozow. Если заказ на удержании по другой причине, например установленной вами, последующий платёж только добавляет примечание, а статус «Processing» вы устанавливаете сами.

Возвраты

Возвраты из WooCommerce не поддерживаются. Верните платёж в личном кабинете мерчанта Ozow и вручную зафиксируйте возврат в WooCommerce.

Лицензионный ключ

Плагин работает с лицензионным ключом VibeFox, полученным на vibefox.net. Блок лицензии находится вверху страницы WooCommerce > Settings > Payments > Ozow. Вставьте ключ в поле License key и нажмите Activate. В блоке отображается статус, например дата, до которой действует лицензия, и ваш домен. Кнопка Check now повторно проверяет статус, Change key позволяет ввести другой ключ, а Remove key удаляет его с этого сайта. Ссылка Manage licenses and domains in your account открывает ваш аккаунт на vibefox.net.

Один ключ работает на одном домене. Удаление ключа с сайта не освобождает слот домена. Освободите слот в своём аккаунте на vibefox.net.

Без активного ключа Ozow не показывается покупателям при оформлении заказа. Если платёж всё же начат, покупатель видит сообщение This payment method is not available. Please choose another one. Вошедшие менеджеры магазина по-прежнему видят способ оплаты с пометкой (unlicensed — visible to admins only), чтобы вы могли настроить и протестировать плагин до покупки ключа. Напоминание появляется на странице Plugins и на страницах WooCommerce. Существующие заказы не затрагиваются: уже начатые платежи по-прежнему подтверждаются.

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

Устранение неполадок

Ozow не появляется при оформлении заказа: проверьте, что лицензия активна, включён Enable/Disable, заполнены Site Code и Private Key, а валюта магазина или заказа — ZAR. Если чего-то не хватает, страница настроек покажет предупреждение.

Платёж прошёл, но заказ остаётся в статусе Pending payment: уведомление Ozow не дошло до магазина, и покупатель не вернулся. Проверьте, что ваш сайт доступен из интернета (нет режима обслуживания, парольной защиты и брандмауэра, блокирующего Ozow). Если ваш сайт Ozow использует фиксированные URL, проверьте, что URL уведомления совпадает с показанным в настройках. Включите Debug log и посмотрите WooCommerce > Status > Logs, источник wcp_ozow_pay.

Уведомление отвечает Invalid hash: Private Key в настройках не принадлежит сайту Ozow, который отправил ответ. Скопируйте его заново из личного кабинета мерчанта Ozow.

Уведомление отвечает Unknown site: ответ пришёл с другого сайта Ozow. Проверьте Site Code.

Уведомление отвечает Order mismatch или Order not found: ответ не относится к заказу этого магазина. Ничего не меняется.

Уведомление отвечает Gateway not configured: не указан Site Code или Private Key. Заполните их; Ozow может повторить попытку.

Уведомление отвечает Order busy: в тот же момент обрабатывался другой ответ Ozow по тому же заказу. Этот ответ не применяется; его применит следующее уведомление или возврат покупателя.

Уведомление отвечает Payment not confirmed yet: с API Key GetTransaction API не смог подтвердить платёж. Заказ на удержании, и следующее уведомление его завершит. Если он остаётся на удержании, проверьте API Key и платёж в личном кабинете Ozow.

Покупатель видит Ozow accepts payments in South African rand (ZAR) only: заказ в другой валюте. Ozow для него использовать нельзя.

Тестовый платёж не оплатил заказ: шлюз работает в боевом режиме. Тестовые платежи никогда не оплачивают заказ в боевом режиме; примечание к заказу сообщает об этом.

Заказ On hold после оплаты: прочитайте примечание к заказу и проверьте платёж в личном кабинете Ozow, затем переведите заказ в статус «Processing» или верните платёж в Ozow.

Блок лицензии показывает ошибку: следуйте сообщению в блоке. Например, если ключ уже используется на другом домене, освободите слот в аккаунте vibefox.net и нажмите Check now. Если адрес сайта изменился, нажмите Check now, чтобы активировать ключ для нового домена. Если сервер лицензий недоступен, плагин продолжает работать по последнему известному статусу.

Удаление

Деактивация плагина сохраняет все данные. Чтобы удалить его, деактивируйте и удалите плагин на странице Plugins. Лицензионный ключ и статус лицензии этого плагина всегда удаляются. Настройки шлюза, остальные параметры плагина и его журналы удаляются только если была включена опция Delete data on uninstall. Иначе они сохраняются для последующей переустановки. Существующие заказы сохраняют свои примечания об оплате и ID транзакций.

Ozow является товарным знаком его владельца. Этот плагин не связан с Ozow и не одобрен компанией Ozow.