VibeFox PayPlug for WooCommerce — Help

Requirements

WordPress: 6.0 or later.

WooCommerce: 7.0 or later, installed and active. The plugin refuses to activate without it.

PHP: 8.0 or later.

Currency and amounts: euro (EUR), from 0.99 to 20,000.00 per payment, the PayPlug defaults. With another 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 site must be reachable from the internet to receive notifications; otherwise orders are updated when the customer returns from PayPlug.

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_payplug_gateway folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Payments > PayPlug > 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. Paste your secret keys from the PayPlug portal (see Configuration).

6. Turn on Enable/Disable and save. Test a payment with Test Mode on, then untick it to accept real payments.

Configuration

All settings are on one page: WooCommerce > Settings > Payments > PayPlug. 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 store currency is not EUR. In both cases the payment method is hidden at checkout. In the list of payment methods, PayPlug shows a test mode badge in test mode and is marked as needing setup until the current mode has a secret key.

Checkout

Enable/Disable: Enable PayPlug Gateway turns the payment method on or off. Default: off.

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

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 also shows the notification URL the plugin sends with every payment. It looks like https://your-site/wc-api/ppg_payplug_webhook/. No notification setup is needed in PayPlug.

Test Mode: Enable 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.

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.

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: Enable debug logging logs API calls and notifications in WooCommerce > Status > Logs, source wcp_payplug_gateway. Errors are always logged. Secret keys, card data and customer data are never logged. Default: off.

Delete Data on Uninstall: Remove all plugin data when uninstalling. When checked, the plugin settings and its logs are deleted when the plugin is deleted. PayPlug payment IDs stored on orders are kept. Default: off.

Checkout

The customer chooses the payment method (by default PayPlug) and places the order. In test mode the checkout shows Test mode: no real payment will be made. The plugin creates a PayPlug payment for the order total in cents and sends the customer to the PayPlug payment page. The billing and shipping details of the order and the language of your site are passed to PayPlug. There the customer pays by card.

After paying, the customer returns to your store. The order is marked paid only after PayPlug confirms it: the plugin reads the payment from the PayPlug API when the notification arrives and when the customer comes back. A paid payment leads the customer to the order received page.

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 comes back to the Pay for order page with a message, for example 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. or The PayPlug payment failed. Please try again or choose another payment method.

When the customer pays the same order again, the plugin first looks at the previous attempt. If it was paid in the meantime, the order is completed 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 sees 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 added to the order notes.

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).

Payments are captured immediately. The plugin has no Oney installments, Bancontact, Apple Pay or American Express, no one-click saved cards, no embedded payment form, no subscriptions and no deferred capture.

Orders and refunds

Order statuses

Pending payment: the customer was sent to PayPlug and has not paid yet, or PayPlug has not confirmed the payment yet.

Processing or Completed: the payment was confirmed. The status follows Order Status After Payment. The order note shows the PayPlug payment and its mode. The transaction ID is the PayPlug payment ID (pay_...).

On hold: the paid amount or currency differs from the order (note amount/currency mismatch); or a test payment was made while the store is in live mode, so no money was received; 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 order note explains what to check.

Failed: the latest payment attempt of a pending order failed or was cancelled. A failure of an older attempt does not change the order. The customer can pay again.

If a second attempt of an order 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.

Refunds

Open the order, click Refund, enter the amount and click Refund via PayPlug. Full and partial refunds are supported. 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, WooCommerce shows the error and no refund is recorded. A successful refund is added to the order notes with the PayPlug refund ID.

Refunds made in the PayPlug portal arrive by notification and are added to the order notes. They are not created in WooCommerce automatically. Record them manually if needed.

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Payments > PayPlug. 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, 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. 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, and refunds work.

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

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 store currency is EUR and the order total is between 0.99 and 20,000.00 EUR. Accounts with other limits can change them with the filter ppg_amount_limits (values in cents).

The payment went through, but the order stays Pending payment: the notification did not reach your store and the customer did not come back. Check that your site is reachable from the internet at the notification URL shown in the settings, for example that no maintenance mode, firewall or password protection blocks it. Look at WooCommerce > Status > Logs, source wcp_payplug_gateway, for rejected notifications.

Notification answers Verification failed: the payment could not be read from the PayPlug API, for example because PayPlug did not answer. The order is not changed, and PayPlug sends the notification again.

Notification answers Busy, retry: the order was being updated by another request at the same moment, for example the customer return. PayPlug sends the notification again.

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

The customer sees Payment could not be initiated: the previous payment attempt of the order is being confirmed at this moment, or PayPlug rejected the request. Wait a moment and try again; the order notes show the PayPlug error.

The order is On hold after payment: read the order note. The paid amount or currency differed from the order, a test payment was made while the store is live, or the payment arrived after the order had been cancelled. 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.

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 are always removed. The gateway settings and the logs are removed only if Delete Data on Uninstall was on. Otherwise they stay for a later re-install. Existing orders keep their payment notes, transaction IDs and PayPlug payment IDs.

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