EN
EUR
Back

VibeFox Autopay for WooCommerce — Help

Requirements

WordPress: 6.0 or later.

WooCommerce: 8.0 or later, installed and active.

PHP: 8.0 or later.

Autopay service: you need the Service ID and Shared key (hash key) of your Autopay service. They are shown in the Autopay merchant portal: portal.autopay.eu for production, testportal.autopay.eu for test. Test services have their own Service ID and Shared key; ask Autopay to open one. The hash function of the service must be SHA-256.

Currency: the store currency must be PLN, EUR, GBP, USD or CZK and accepted by your Autopay service.

Reachable store: Autopay must be able to send notifications to your store, so it must be reachable from the internet without maintenance mode, basic authentication or a firewall that blocks POST requests.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the wcp_autopay_payment folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Payments > Autopay > Manage, or click Settings under the plugin name on the Plugins page.

4. Enter your VibeFox license key in the license block at the top of the page and click Activate.

5. Enter the Service ID and Shared key (test and production) and choose the currencies of your service.

6. In the Autopay portal set the ITN URL, the return URL and the SHA-256 hash function for your service (see Configuration).

7. Turn on Enable/Disable. Place a test order in test mode, then untick Test mode for real payments.

Configuration

All settings are on one page: WooCommerce > Settings > Payments > Autopay. Above the fields the page warns you when the Service ID or Shared key of the selected environment is empty, and when the store currency is not selected in Currencies. In both cases the payment method is hidden at checkout. In the list of payment methods, Autopay is marked as needing setup until the selected environment has credentials.

General

Enable/Disable: Enable Autopay payment gateway turns the payment method on or off. Default: off.

Title: the payment method name customers see at checkout. Default: Autopay.

Description: the text shown under the payment method at checkout. Default: Pay online by bank transfer, BLIK or card. You will be redirected to the secure Autopay payment page.

Autopay service

The Service ID and Shared key are shown in the Autopay merchant portal (portal.autopay.eu or testportal.autopay.eu).

Test mode: Use the Autopay test environment (testpay.autopay.eu) and the test credentials below. Default: on. Turn it off to accept real payments on pay.autopay.eu with the production credentials.

Service ID (production): the numeric service identifier from portal.autopay.eu.

Shared key (production): the hash key of the production service. Keep it secret.

Service ID (test): the numeric service identifier from testportal.autopay.eu.

Shared key (test): the hash key of the test service.

Currencies: the currencies your Autopay service accepts: PLN, EUR, GBP, USD, CZK. Autopay usually opens a separate service per currency. The payment method is offered only when the order currency is selected here. Default: PLN.

Payment notifications (ITN) and return address

Enter these addresses in the Autopay portal for your service, for production and for test. The exact addresses are shown in this section of the settings.

ITN (transaction notification) URL: https://your-site/?wc-api=wc_ap_payment
Return URL (after payment): https://your-site/?wc-api=wc_ap_return

Without the ITN URL orders are never marked as paid. Each ITN is checked with the SHA-256 hash made with the Shared key of the matching service. Notifications without a valid hash or for an unknown Service ID are rejected. A notification is applied to an order only if the payment for that order was started with the same Autopay service. Notifications for payments started before you switched Test mode are still verified with the right key.

The plugin handles these payment statuses in the ITN:

SUCCESS: the payment was made; the order is marked paid after the amount and currency check.
PENDING: the payment was started; a note is added.
FAILURE: the payment failed; a waiting order becomes Failed.

Advanced

Logging: Log payment events to WooCommerce > Status > Logs, source wcp_autopay_payment. Keys and customer data are never logged. Default: off.

Checkout

The customer chooses the payment method (by default Autopay) and places the order. The next page shows Thank you for your order. You are being redirected to Autopay to complete the payment. and sends the customer to the Autopay payment page. If the customer comes back with the browser's back button, the page shows the Pay with Autopay button instead of redirecting again.

The plugin passes the order total in the order currency, the order number as the description (Order and the number) and the customer's billing e-mail. On the Autopay page the customer chooses the payment method and pays.

After paying, the customer returns to the order received page. The return address is signed, but it never changes the order status. The order is marked paid only after Autopay confirms it with a signed ITN and the amount and currency match the order.

If the payment fails, the order becomes Failed and the customer can pay again from the order with the Pay link. If the payment cannot be started, the customer sees a short message, for example Autopay payments are not configured. Please choose another payment method or contact the store. or that Autopay cannot accept payments in this currency.

The payment method works on the classic checkout, on the Checkout block and on the Pay for order page. It is compatible with WooCommerce High-Performance Order Storage (HPOS).

The plugin has no refunds from WooCommerce, no subscriptions or recurring payments, no saved cards (1-Click), no BLIK code or card form on the checkout page, no choice of bank or payment channel on the checkout page, and it uses one Service ID per environment.

Orders

Order statuses

Pending payment: the customer was sent to Autopay and Autopay has not confirmed the payment yet.

Processing or Completed: Autopay confirmed the payment. WooCommerce sets Processing, or Completed for orders with only virtual downloadable products. The order note shows the amount, the Autopay transaction and the payment date. The transaction ID is the Autopay transaction ID (RemoteID).

On hold: Autopay reported a different amount or currency than the order total. The order was not marked as paid. Check the transaction in the Autopay portal and complete or refund it manually.

Failed: the payment failed. The customer can pay again from the order.

A paid order is never changed by a later failure notification. If Autopay reports another successful payment for a paid order, a note warns that the customer may have paid twice. A notification for a payment started with another Autopay service is not applied, and a note explains it.

Refunds

Refunds from WooCommerce are not supported. Refund the payment in the Autopay portal, then record it in WooCommerce with a manual refund.

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Payments > Autopay. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.

One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Autopay is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. Logged-in store managers still see the payment method, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected: payments already started are still confirmed.

When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.

Troubleshooting

Autopay does not appear at checkout: check that the license is active, Enable/Disable is on, the selected environment has a Service ID and Shared key, and the store currency is selected in Currencies. The settings page shows a warning when one of these is missing.

The payment went through, but the order stays Pending payment: Autopay did not deliver the ITN, or the store rejected it. Check that the ITN URL shown in the settings is set for the service in the Autopay portal (production or test), that the hash function is SHA-256 and that the Shared key in the plugin matches the service. Check that the store is reachable from the internet. Turn on Logging and look at WooCommerce > Status > Logs, source wcp_autopay_payment.

The log shows ITN rejected: invalid hash: the Shared key does not match the service, or the hash function of the service is not SHA-256.

The log shows that the service ID is not configured: the notification came from a service whose Service ID is not entered in the plugin.

The order was put On hold with a mismatch note: Autopay reported a different amount or currency than the order total. Check the transaction in the Autopay portal and complete or refund the order manually.

A note says the notification was NOT applied: the payment for this order was not started with this Autopay service, for example a test notification for a live order. Check the transaction in the Autopay portal.

After paying, the customer lands on the home page: the return address could not be verified, for example because the Service ID is not entered in the plugin. The order status is not affected; it follows the ITN.

The license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.

Uninstall

Deactivating the plugin keeps all data. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin and the gateway settings are removed. The plugin has no option to keep the settings. Existing orders keep their payment notes and transaction IDs.

Autopay is a trademark of its respective owner. This plugin is not affiliated with or endorsed by Autopay.