VibeFox PayPlug for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

Currency and amounts: euro (EUR), from 0.99 to 20,000.00 per payment, the PayPlug defaults. With another cart currency or outside these limits the payment method is hidden.

PayPlug account: you need the secret keys of your PayPlug account: the test key (sk_test_...) and/or the live key (sk_live_...). No other keys are needed, and no notification has to be set up in PayPlug. Your shop must be reachable from the internet to receive notifications; otherwise orders are created when the customer returns from PayPlug.

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 PayPlug Gateway 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. Paste your secret keys from the PayPlug portal (see Configuration).

5. Turn on Enable/Disable and click Save. Test a payment with Test Mode on, then turn it off to accept real payments.

On install the module creates the order status PayPlug 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 PayPlug Gateway > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page warns you when the payment method is enabled but the secret key of the current mode is empty, and when the default currency of the shop is not EUR. In both cases the payment method is hidden at checkout.

Checkout

Enable/Disable: Enable PayPlug 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: PayPlug. Required.

Description: the text shown under the payment method at checkout. Default: Pay securely by card via PayPlug.

API keys

Find your secret keys in the PayPlug portal under Developers > API keys. The section has a link to the portal.

Test Mode: uses the test secret key for new payments. No real payments are processed. Payments made in the other mode keep using the key of their own mode for status checks and refunds. Default: on. While it is on, customers see Test mode: no real payment will be made. under the payment method.

Test Secret Key: your PayPlug test secret key. It starts with sk_test_.

Live Secret Key: your PayPlug live secret key. It starts with sk_live_.

A key with the wrong prefix is not saved. The page shows, for example, Test Secret Key must start with "sk_test_". The previous value was kept. Saved 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.

Notification URL: the address the module sends to PayPlug with every payment. With friendly URLs it looks like https://your-shop/module/wcp_payplug_gateway/webhook. Nothing has to be entered in the PayPlug portal. The URL must be reachable from the internet; otherwise orders are created when the customer returns from PayPlug.

Orders

Order Status After Payment: the order status set after a successful payment. The status is set at once, without a second status change.

Advanced

Logging: logs API calls and notifications to logs/ppg_debug.log.php in the module folder. The file cannot be opened from the web. Errors and warnings are always logged. Secret keys, card data and customer data are never logged. Default: off.

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

Delete Data on Uninstall: when on, the module settings and its log are deleted when the module is uninstalled. The PayPlug payment IDs stored with orders and the order status PayPlug payment on hold are kept. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default PayPlug, with the PayPlug logo). In test mode the option shows Test mode: no real payment will be made. After confirming, the module creates a PayPlug payment for the cart total in cents and sends the customer to the PayPlug payment page. The billing and delivery addresses, the e-mail and the language of the cart are passed to PayPlug. There the customer pays by card. No order exists yet at this point.

After paying, the customer returns to your shop. The order is marked paid only after PayPlug confirms it: the module reads the payment from the PayPlug API when the notification arrives and when the customer comes back. The order is then created and the customer sees the standard order confirmation page with Your payment with PayPlug has been received. If the order is on hold, the page says We are confirming your payment with PayPlug. The order will be updated automatically — please do not pay again. If the order is in Payment error or was cancelled without payment, the page says Your PayPlug payment was not completed. Please contact us about this order. If PayPlug could not be asked when the customer comes back, a Payment confirmation page shows the same "we are confirming" text and a Check again button; the notification creates the order as soon as it arrives.

If the customer cancels on the PayPlug page, the payment page is closed at PayPlug, so it cannot be paid later by mistake. The customer is back at checkout with a message: You cancelled the PayPlug payment. You can try again or choose another payment method., The PayPlug payment session has expired. Please try again or choose another payment method., The PayPlug payment failed. Please try again or choose another payment method. or, if the payment was left open, Your PayPlug payment was not completed. You can try again or choose another payment method. The cart is kept.

When the customer pays the same cart again, the module first looks at the previous attempt. If it was paid in the meantime, the order is created without a new payment. If it is still open for the same amount, the same payment page is used again. Otherwise the old page is closed at PayPlug and a new payment is created.

If PayPlug cannot start the payment, the customer stays at checkout with a short message, for example PayPlug could not accept your billing details (postcode). Please check them and try again. or The payment provider could not be reached. Please try again in a moment. The technical reason is written to the log.

The notification works while the shop is in maintenance mode and is not blocked by the country restriction of your shop.

Payments are captured immediately. The module has no Oney installments, no one-click saved cards, no embedded payment form, no subscriptions and no deferred capture.

Orders and refunds

Order statuses

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

Payment accepted or Delivered: the payment was confirmed. The status follows Order Status After Payment. The payment is recorded with the PayPlug payment ID (pay_...) as the transaction ID, and a note shows the PayPlug payment and its mode.

PayPlug payment on hold: the paid amount or currency differs from the cart (note amount/currency mismatch, for example the cart was changed after the payment started); or a test payment was made while the shop is in live mode, so no money was received and no payment is recorded; or the payment arrived for an order that had been cancelled; or a payment is authorized but not captured (capture it in the PayPlug portal, the order is marked paid when PayPlug reports it as paid). The note explains what to check.

Payment error: an authorized payment of an on-hold order failed or was cancelled.

Refunded: the payment was fully refunded through the module.

If a second attempt of a cart that is already paid is paid as well, the order is not changed. A note asks you to refund the duplicate payment in the PayPlug portal. A paid, cancelled or refunded order is never reopened by a later notification.

PayPlug payment block

The order page shows a PayPlug payment block with the PayPlug payment ID, the payment status, the amount paid and refunded, a Test mode badge for test payments, the refund history and the PayPlug notes of the order.

Refunds

In the PayPlug payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via PayPlug. Confirm the question Refund this amount through PayPlug? This cannot be undone. Full and partial refunds are supported. You need the right to edit orders; access to the Modules pages is not needed. Refunds are made up to the amount PayPlug actually charged, so after an amount mismatch you can refund what the customer paid, not the order total. The refund goes to the payment that actually paid the order, with the secret key of the mode (test or live) it was made in, so that mode's key must be set. If PayPlug does not accept the refund, the block shows the error and no refund is recorded. A successful refund is added to the refund history and the notes with the PayPlug refund ID and the reason. A full refund sets the order to Refunded. A partial refund does not change the status. Refunds are available once PayPlug has reported the payment as paid.

The module does not create credit slips. The standard PrestaShop refund buttons of the order page do not send money back through PayPlug.

Refunds made in the PayPlug portal arrive by notification and are added to the notes once. They are not counted in the block and do not change the order status or credit slips. Record them manually if needed.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox PayPlug Gateway is the first block on Modules > Module Manager > VibeFox PayPlug Gateway > 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-payplug 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, PayPlug 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, and refunds work.

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

PayPlug does not appear at checkout: check that the license is active, Enable/Disable is on, the current mode has a secret key (Test Secret Key in test mode, Live Secret Key in live mode), the cart currency is EUR and the cart total is between 0.99 and 20,000.00 EUR. In Payment > Preferences check that the module is allowed for the cart currency, the customer's country and the customer's group. Developers can change the currencies and limits with the hooks actionWcpPayplugSupportedCurrencies and actionWcpPayplugAmountLimits (values in cents).

The payment went through, but no order was created: the notification did not reach your shop and the customer did not come back. Check that your shop is reachable from the internet at the Notification URL shown in the settings, for example that no firewall or password protection blocks it. Turn on Logging and look at the Log field for rejected notifications.

Notification answers Verification failed.: the payment could not be read from the PayPlug API, for example because PayPlug did not answer or the secret key of the payment's mode is not set. The order is not changed, and PayPlug sends the notification again.

Notification answers Temporarily unavailable.: the cart was being updated by another request at the same moment, for example the customer return, or the order could not be created (for example, the module is disabled). PayPlug sends the notification again. The log shows the reason.

Notification answers Unknown payment. or Payment does not belong to the order.: the payment was not created by this shop or not for this cart, for example a payment of another shop on the same PayPlug account. It is ignored.

The notification URL shows Method not allowed. in the browser: this is normal. The URL accepts only requests from PayPlug.

The customer sees an error when choosing PayPlug: turn on Logging and look at the Log field. A wrong key gives This payment method is temporarily unavailable. Please choose another payment method.; other messages name the billing field PayPlug rejected.

Order is PayPlug payment on hold after payment: read the notes in the PayPlug payment block (see Order statuses), then process the order or refund the payment.

Refund fails with a message about the mode: the payment was made in test or live mode, and the secret key of that mode is not configured. Enter it and try again.

Refund fails with Unexpected response from PayPlug.: PayPlug answered without a valid refund. Nothing was recorded. Check the refund in the PayPlug portal before trying again.

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox PayPlug Gateway and choose Uninstall. The license key and license status of this module are always removed. If Delete Data on Uninstall is on, the module settings and the log are removed. If it is off, all settings are kept for a later re-install. The PayPlug payment and refund records and the order status PayPlug payment on hold are always kept, so orders paid before can still be refunded after a re-install. Existing orders keep their payment notes and transaction IDs.

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