VibeFox Helcim for WooCommerce — Допомога

Вимоги

WordPress: 5.8 або новіша версія.

WooCommerce: 7.0 або новіша, встановлений та активний. Без WooCommerce плагін відмовляється активуватися.

PHP: 8.0 або новіша.

HTTPS та PCI DSS: дані картки вводяться під час оформлення замовлення та надсилаються з вашого сервера до Helcim через HTTPS. Вони ніколи не зберігаються і не записуються до журналу, але проходять крізь ваш сервер, тому вашому магазину потрібен SSL-сертифікат, а хостинг повинен відповідати PCI DSS (SAQ D).

Обліковий запис Helcim: обліковий запис мерчанта Helcim у Канаді або Сполучених Штатах та API-токен із правами на обробку транзакцій (див. Налаштування). Helcim обробляє CAD і USD. Тестовий обліковий запис Helcim (для розробників) необов'язковий і використовується для тестування.

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

Встановлення

1. У WordPress перейдіть до Plugins > Add New > Upload Plugin, виберіть ZIP-файл плагіна та натисніть Install Now. Ви також можете завантажити папку wcp_helcim_gateway до /wp-content/plugins/ через FTP.

2. Натисніть Activate.

3. У Helcim відкрийте All Tools > Integrations > API Access Configuration, створіть доступ до API з правами на обробку транзакцій (покупки, попередні авторизації, захоплення, повернення коштів) і скопіюйте його токен.

4. Відкрийте налаштування: WooCommerce > Settings > Payments > Helcim > Manage або натисніть Settings під назвою плагіна на сторінці «Плагіни».

5. Введіть ваш ліцензійний ключ VibeFox у блок ліцензії у верхній частині сторінки та натисніть Activate.

6. Вставте токен у Live API token, а токен вашого тестового облікового запису Helcim — у Test API token, якщо він у вас є.

7. Виберіть Transaction type та Account currencies, увімкніть Enable / Disable і збережіть. Щоб спершу протестувати, увімкніть Test mode та здійсніть оплату через свій тестовий обліковий запис; потім вимкніть його.

Налаштування

Усі параметри зібрано на одній сторінці: WooCommerce > Settings > Payments > Helcim. Над полями сторінка попереджає вас, якщо валюта магазину не входить до списку Account currencies, а також якщо при увімкненому шлюзі API-токен поточного режиму порожній. В обох випадках шлюз приховується під час оформлення замовлення. У списку способів оплати шлюз позначається як такий, що потребує налаштування, доки поточний режим не матиме токена.

Enable / Disable: Enable Helcim Gateway вмикає або вимикає спосіб оплати. За замовчуванням: вимкнено.

Title: назва способу оплати, що показується під час оформлення замовлення. За замовчуванням: Credit card (Helcim).

Description: опис способу оплати, що показується під час оформлення замовлення. За замовчуванням: Pay securely with your credit card.

Облікові дані API

У Helcim перейдіть до All Tools > Integrations > API Access Configuration, створіть доступ до API та скопіюйте його токен. Надайте йому права на обробку транзакцій для покупок, попередніх авторизацій, захоплень та повернень коштів. Тестові облікові записи Helcim використовують ту саму адресу API, що й робочі, тому тестовий режим просто використовує токен вашого тестового облікового запису Helcim.

Live API token: API-токен вашого робочого облікового запису Helcim. Використовується, коли тестовий режим вимкнено.

Test mode: Use the Test API token (Helcim test account). Платежі, захоплення та повернення коштів надходять до вашого тестового облікового запису Helcim, а покупці бачать сповіщення про тестовий режим. Повернення та захоплення за замовленням завжди використовують токен того режиму, в якому було здійснено оплату замовлення. За замовчуванням: вимкнено.

Test API token: API-токен вашого тестового облікового запису Helcim (для розробників). Використовується, коли тестовий режим увімкнено.

Оплата

Transaction type: спосіб списання коштів із картки.

Purchase: списує кошти з картки негайно, і замовлення отримує статус «Обробка» (за замовчуванням).

Pre-authorization: лише резервує кошти, і замовлення переходить у статус «На утриманні». Захопіть їх пізніше за допомогою дії із замовленням Capture Helcim pre-authorization або повністю поверніть кошти за замовленням, щоб скасувати резервування.

Account currencies: валюти, які може обробляти ваш обліковий запис Helcim. Кошти за замовлення завжди списуються у валюті замовлення. Для інших валют шлюз приховується під час оформлення замовлення.

CAD — Canadian Dollar: за замовчуванням.

USD — US Dollar.

CAD and USD.

Додатково

Debug log: Log API requests and responses у WooCommerce > Status > Logs, джерело wcp_helcim_gateway. Номери карток скорочуються до останніх 4 цифр. CVC, термін дії, токени, імена, адреси, електронні адреси та IP-адреси ніколи не записуються до журналу. За замовчуванням: вимкнено.

Delete data on uninstall: Remove the gateway settings, its own options (wc_hlg_*) and its log files when the plugin is deleted. За замовчуванням: вимкнено.

Оформлення замовлення

Покупець вибирає спосіб оплати (за замовчуванням Credit card (Helcim)) і вводить Card Number, Expiry (MM/YY), CVC та Cardholder Name під час вашого оформлення замовлення. Поруч із заголовком відображаються значки Visa, Mastercard, American Express та Discover. У тестовому режимі форма показує повідомлення TEST MODE — payments go to a Helcim test account, no real charges are made. Перед надсиланням плагін перевіряє контрольну суму номера картки, дійсність терміну дії (що він не в минулому), наявність 3 або 4 цифр у CVC та заповненість імені.

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

Для одного замовлення одночасно виконується лише одна спроба оплати, а за вже оплаченим замовленням кошти ніколи не списуються повторно. Кожна спроба використовує ключ ідемпотентності. Якщо Helcim не відповідає, замовлення залишається зі статусом «Очікування оплати», і повторна спроба протягом 5 хвилин повертає початковий результат Helcim замість подвійного списання з картки.

Повідомлення, які може бачити покупець: Your card was declined. Please check the card details or use another card. коли Helcim відхиляє оплату; Payment failed: із зазначенням причини від Helcim для інших відхилених запитів; We could not confirm your payment with the card processor. Please try again in a minute; if the problem persists, contact us before using another card. коли Helcim не відповідає; This payment method is temporarily unavailable. Please choose another payment method. коли API-токен відсутній або відхилений; Your payment is already being processed. Please wait a moment and check your e-mail before trying again. при подвійному надсиланні. Технічні деталі записуються до приміток до замовлення та журналу.

Спосіб оплати працює на класичному оформленні замовлення, у блоці «Оформлення замовлення» (з тими самими полями введення картки) та на сторінці Pay for order. Він сумісний із високопродуктивним сховищем замовлень WooCommerce (HPOS).

Плагін не використовує HelcimPay.js або Helcim.js, тому дані картки проходять крізь ваш сервер. Він не підтримує збережені картки, підписки, банківські платежі чи ACH, Apple Pay, Google Pay або 3-D Secure, і не отримує вебхуків Helcim.

Замовлення та повернення коштів

Статуси замовлення

Pending payment: платіж було відхилено або ще не підтверджено. Якщо Helcim не відповів, примітка до замовлення просить вас перевірити інвойс у Helcim, перш ніж знову стягувати кошти з покупця.

Processing: покупку було схвалено або попередню авторизацію було захоплено. Замовлення лише з віртуальними товарами для завантаження отримують статус «Виконано», стандартний для WooCommerce. Примітка до замовлення показує ID транзакції, код схвалення, тип картки, останні 4 цифри та режим. ID транзакції є ідентифікатором транзакції Helcim.

On hold (pre-authorization): кошти лише зарезервовано. Захопіть їх за допомогою дії із замовленням або вивільніть повним поверненням коштів.

On hold after payment: Helcim схвалив транзакцію, але сума, валюта або ID транзакції у відповіді не збігаються із замовленням. У примітці зазначено Helcim response verification FAILED. Перевірте транзакцію в Helcim перед виконанням замовлення.

Захоплення

Відкрийте замовлення (статус «На утриманні»), виберіть дію із замовленням Capture Helcim pre-authorization і натисніть Update. Захоплюється поточна загальна сума замовлення за вирахуванням повернень. Вона може бути меншою за авторизовану суму, але не більшою. Захоплення використовує токен того режиму, в якому було оплачено замовлення. Після успішного захоплення замовлення переходить у статус «Обробка», а ID транзакції змінюється на транзакцію захоплення. Якщо захоплення зазнає невдачі, причина відображається та додається до приміток до замовлення.

Повернення коштів

Відкрийте замовлення, натисніть Refund, введіть суму та натисніть Refund via Credit card (Helcim) (на кнопці відображається ваш Title). Підтримуються повні та часткові повернення за покупкою або захопленою попередньою авторизацією. Незахоплену попередню авторизацію можна повернути лише повністю: утримання знімається і з покупця кошти не стягуються. Повернення коштів надсилається в тому режимі, в якому було сплачено замовлення, тому токен цього режиму має бути встановлено. Воно зараховується лише після того, як Helcim схвалить його. Якщо Helcim відхиляє його, WooCommerce показує помилку і повернення не фіксується. Успішне повернення додається до приміток до замовлення з ID транзакції повернення Helcim. Повторна спроба після тайм-ауту не здійснює повернення двічі.

Плагін не отримує вебхуків Helcim. Захоплення, повернення та скасування, здійснені в панелі керування Helcim, не відображаються у WooCommerce, тому виконуйте їх із WooCommerce.

Ліцензійний ключ

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

Один ключ діє на одному домені. Видалення ключа із сайту не звільняє його слот домену. Звільніть слот у вашому обліковому записі vibefox.net.

Без активного ключа спосіб оплати Helcim не показується покупцям під час оформлення замовлення. Якщо платіж усе одно розпочато, покупець бачить повідомлення This payment method is not available. Please choose another one. Авторизовані менеджери магазину все ще бачать спосіб оплати з позначкою (unlicensed — visible to admins only), тож ви можете налаштувати та протестувати плагін перед придбанням ключа. Нагадування з'являється на сторінці «Плагіни» та на сторінках WooCommerce. На наявні замовлення це не впливає: захоплення та повернення коштів продовжують працювати.

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

Усунення несправностей

Helcim не відображається під час оформлення замовлення: перевірте, чи ліцензія активна, Enable / Disable увімкнено, поточний режим має свій API-токен (Live API token або Test API token у тестовому режимі), а валюта кошика входить до Account currencies. На сторінці Pay for order враховується валюта замовлення. Сторінка налаштувань показує попередження в обох випадках.

Helcim не відповів, і замовлення залишається зі статусом «Очікування оплати»: можливо, з картки було списано кошти. Прочитайте примітку до замовлення та перевірте інвойс у Helcim, перш ніж знову стягувати кошти з покупця. Повторна спроба протягом 5 хвилин повертає початковий результат і не списує кошти двічі.

Покупці бачать This payment method is temporarily unavailable: API-токен поточного режиму порожній або був відхилений Helcim. Примітка до замовлення повідомляє про необхідність перевірити токен та його дозволи. Переконайтеся, що доступ до API має права на обробку транзакцій.

Платіж не пройшов із зазначенням причини Helcim: Helcim відхилив запит, наприклад через дані картки або платіжні реквізити. У примітці до замовлення є деталі.

Замовлення перебуває в статусі «На утриманні» після оплати: прочитайте примітку до замовлення. Замовлення було попередньо авторизовано та очікує на захоплення, або відповідь Helcim не збіглася із замовленням (перевірка відповіді не вдалася).

Захоплення неможливе: сума для захоплення має бути більшою за 0 і не перевищувати авторизовану суму, а токен того режиму, в якому було сплачено замовлення, має бути встановлено.

Повернення коштів не вдається: прочитайте повідомлення. Незахоплену попередню авторизацію можна повернути лише повністю. Повідомлення про режим означає, що токен режиму, в якому було оплачено замовлення, порожній. Відхилене повернення не фіксується.

Тестові платежі: тестовий режим надсилає платежі, захоплення та повернення коштів до вашого тестового облікового запису Helcim. Замовлення зберігають той режим, у якому вони були оплачені, тому зміна режиму пізніше не переносить їхні захоплення та повернення на інший обліковий запис.

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

Для розробників: фільтр wc_hlg_supported_currencies змінює список валют, а wc_hlg_card_brands змінює значки карток під час оформлення замовлення.

Видалення

Під час деактивації плагіна всі дані зберігаються. Щоб видалити його, деактивуйте та видаліть на сторінці Plugins. Ліцензійний ключ і статус ліцензії цього плагіна видаляються завжди. Налаштування шлюзу, власні опції плагіна та журнали видаляються лише за умови, що опцію Delete data on uninstall було увімкнено. В іншому разі вони залишаються для подальшого повторного встановлення. Дані замовлень є частиною історії замовлень і ніколи не видаляються. Наявні замовлення зберігають свої платіжні примітки та ID транзакцій.

Helcim є товарним знаком відповідного власника. Цей плагін не пов'язаний із Helcim і не схвалений нею.