VibeFox Autopay for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

PHP: 8.0 or later. The module refuses to install on older PHP versions.

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 cart currency must be PLN, EUR, GBP, USD or CZK and accepted by your Autopay service.

Reachable shop: Autopay must be able to send notifications to your shop, so it must be reachable from the internet without basic authentication or a firewall that blocks POST requests. Maintenance mode and the country restriction of your shop do not block the notifications.

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

Installation

1. In the back office go to Modules > Module Manager and click Upload a module. Choose the module ZIP file.

2. When the upload finishes, click Configure, or find VibeFox Autopay Payment in the module list later and click Configure.

3. Paste your VibeFox license key into License key in the license block at the top of the Configure page and click Activate (see License key).

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

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

6. Turn on Enable/Disable and click Save. Place a test order in test mode, then turn off Test mode for real payments.

On install the module creates the order status Autopay payment on hold. PrestaShop offers a new payment module for all currencies, countries and customer groups. You can limit them in Payment > Preferences.

Configuration

All settings are on the module page: Modules > Module Manager > VibeFox Autopay Payment > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page warns you when the Service ID or Shared key of the selected environment is empty, and when the default currency of the shop is not selected in Currencies. In both cases the payment method is hidden at checkout (for the currency that is not selected).

Autopay

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

Title: the payment method name customers see at checkout. It is also the payment method name stored in the order. Default: Autopay. Required.

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, linked in this section).

Test mode: uses 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.

When you save, a Service ID with other characters than letters, digits, hyphens or underscores is refused with an error, and nothing is saved. Saved Shared keys are never shown again. The field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it.

Clear saved keys: tick a key and click Save to remove it. An empty field keeps the saved value.

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 cart 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 the Addresses field of this section. With friendly URLs they look like this, possibly with a language code such as /en/:

Copy the addresses exactly as the settings show them. Without the ITN URL orders are never created, because PrestaShop creates the order only when Autopay confirms the payment. Each ITN is checked with the SHA-256 hash made with the Shared key of the service named in the notification. Notifications without a valid hash or for an unknown Service ID are rejected. A notification is applied to a cart only if its payment was started with the same Autopay service, so a test notification never confirms a production payment. Notifications for payments started before you switched Test mode are still verified with the right key, as long as both credentials stay saved.

The module handles these payment statuses in the ITN:

Advanced

Logging: writes payment events to logs/wc_ap_debug.log.php in the module folder. The file cannot be opened from the web. Keys and customer data are never logged. Default: off. Nothing is written while it is off, errors included.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Checkout

At the payment step the customer chooses the payment method (by default Autopay) with its description and confirms. The next page shows Thank you. You are being redirected to Autopay to complete the payment. Your order is created as soon as Autopay confirms it. 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. No order exists yet at this point.

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

The order is marked paid only after Autopay confirms it with a signed ITN and the amount and currency match the cart. The order is then created and the customer receives the standard PrestaShop order e-mails. After paying, the customer returns to your shop. The return address is signed, but it never creates or changes an order. If the order already exists, the customer sees the standard order confirmation page. If the ITN has not arrived yet, a Payment confirmation page shows Thank you. Your payment is being confirmed by Autopay — your order will be created as soon as Autopay confirms it, and you will receive an e-mail. with the buttons Check again and Back to checkout.

If Autopay reported a failed payment, the customer is back at checkout with The payment was not completed. You can try again or choose another payment method. The cart is kept. If the payment cannot be started, the customer stays at checkout with 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 module has no refunds from PrestaShop, no subscriptions or recurring payments, no saved cards, 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

No order yet: the customer was sent to Autopay and has not paid, the payment failed, or Autopay has not confirmed the payment yet. Only the cart exists.

Payment accepted: Autopay confirmed the payment and the amount and currency match. The payment is recorded with the Autopay transaction ID (remoteID) as the transaction ID, and a note shows the amount, the Autopay transaction and the payment date.

Autopay payment on hold: Autopay reported a different amount or currency than the cart total (for example, the cart was changed after the payment started). The order is not marked as paid. Check the transaction in the Autopay portal and complete or refund it manually. A later correct notification for this order marks it paid. The same status is used when a payment arrives for an order that had been cancelled: the payment is recorded and a note asks you to check stock and fulfil the order, or refund the payment.

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. Notes are visible to staff only, in the Autopay payment block of the order page.

Autopay payment block

The order page shows an Autopay payment block with the Autopay OrderID, the Service ID and environment, the amount and currency, the payment status, the Autopay transaction ID, a Test mode badge for test payments and the Autopay notes of the order. The block is read only.

Refunds

Refunds through Autopay are not supported. Refund the payment in the Autopay portal, then record it in PrestaShop with the standard order tools.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Autopay Payment is the first block on Modules > Module Manager > VibeFox Autopay Payment > Configure, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this shop. Below them are the line Product: presta-payment-autopay and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only employees with the Configure permission for the module can change the key. The texts of the block follow the back office language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the shop address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the module keeps working on the last known status.

One key works on one domain: the domain of the main shop, also in a multistore setup. Removing the key from the shop 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. The PrestaShop storefront does not know that you are logged in to the back office, so the payment method is hidden for you too: you can set up the module before you buy a key, but not test it at checkout. A reminder appears in Modules > Module Manager on the Alerts tab. Existing orders are not affected: payments already started are still confirmed.

When a license expires, the module keeps working, but updates and support need a renewal. The status is checked again automatically while you work in the back office: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling or resetting the module always removes the license key and license status.

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 cart currency is selected in Currencies. The settings page shows a warning when one of these is missing. In Payment > Preferences check that the module is allowed for the cart currency, the customer's country and the customer's group.

The payment went through, but no order was created: Autopay did not deliver the ITN, or the shop 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 module matches the service. Check that the shop is reachable from the internet. Turn on Logging and look at the Log field on the module page.

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 module, or whose Shared key is empty.

The log shows could not lock the cart, Autopay will retry: the cart was being processed by another notification at the same moment. The shop answers so that Autopay sends the notification again. The same happens when the order could not be created, for example because the module is disabled.

The order is Autopay payment on hold with a mismatch note: Autopay reported a different amount or currency than the cart 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 module. The order is not affected; it follows the ITN.

The customer sees This payment method is not available.: the payment method is not offered for this cart (disabled, missing credentials, currency not selected, or not allowed in Payment > Preferences).

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox Autopay Payment and choose Uninstall. The license key and license status of this module are always removed. The module settings, including the keys, and the log are removed. The module has no option to keep the settings. The Autopay payment records and the order status Autopay payment on hold are always kept. Existing orders keep their payment notes and transaction IDs.

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