VibeFox Stripe for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

Stripe account: you need the secret API keys of your Stripe account and a webhook endpoint in the Stripe Dashboard (see Configuration). Only the secret keys and the webhook signing secrets are used. The publishable keys (pk_...) are not needed, because Stripe Checkout is a Stripe-hosted page.

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 Stripe 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 Stripe secret keys, set up the webhook in the Stripe Dashboard and paste its signing secrets (see Configuration).

5. Turn on Enable/Disable and click Save. Test a payment in test mode with the card 4242 4242 4242 4242, then turn off Test Mode.

On install the module creates two order statuses, Awaiting Stripe payment and Stripe 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 Stripe Gateway > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page warns you when the current mode has no secret key (the payment method is then hidden at checkout) or no webhook signing secret (orders are then confirmed only when the customer returns to the shop), and shows Test mode is on: no real payments are taken. while test mode is on.

Stripe Checkout

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

Description: the text shown under the payment method at checkout. Default: Pay securely with your credit or debit card via Stripe.

API keys

Copy the secret keys from Stripe Dashboard > Developers > API keys. Test and live keys are separate. Test mode uses only the test keys, live mode only the live keys. When you save, the module warns you if a value does not start with the expected prefix, for example when a publishable key was pasted instead of a secret key.

Test Mode: uses the Stripe test keys. No real money is charged; pay with Stripe test cards such as 4242 4242 4242 4242. Default: on. Turn it off to take real payments. While it is on, customers see Test mode: no real payment is taken. under the payment method.

Test Secret Key: the secret key of the test mode. It starts with sk_test_ (or rk_test_ for a restricted key).

Test Webhook Secret: the signing secret (whsec_...) of the webhook endpoint created in test mode.

Live Secret Key: the secret key of the live mode. It starts with sk_live_ (or rk_live_ for a restricted key).

Live Webhook Secret: the signing secret (whsec_...) of the webhook endpoint created in live mode.

Saved keys and secrets 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 secrets: tick a key or secret and click Save to remove it. An empty field keeps the saved value.

Webhook

The webhook tells your shop that a payment has been made. In Stripe Dashboard > Developers > Webhooks add an endpoint in test mode and another one in live mode. Use the URL shown in Endpoint URL in this section. With friendly URLs it looks like https://your-shop/module/wcp_stripe_gateway/webhook, possibly with a language code such as /en/. Copy the URL exactly as the settings show it, because Stripe does not follow redirects.

Select these events for each endpoint (they are also listed in this section):

checkout.session.completed: the customer finished the payment on the Stripe page.

checkout.session.async_payment_succeeded: a delayed payment was confirmed.

checkout.session.async_payment_failed: a delayed payment failed.

charge.refunded: a payment was refunded, for example in the Stripe Dashboard.

After creating each endpoint, copy its signing secret (whsec_...) from Stripe and paste it into Test Webhook Secret or Live Webhook Secret. Webhooks without a valid signature are rejected. An event must be signed with the secret of the mode the payment was made in, so a test secret never confirms a live payment. Without the webhook, an order is created only when the customer comes back to the shop after paying.

Orders

Order Status After Payment: the order status set after a successful payment.

Payment accepted (default): the standard PrestaShop status for paid orders.

Delivered (completed): every paid order becomes Delivered.

Stripe payment on hold (review): every paid order waits for your manual review. The payment is still recorded on the order.

Delayed payments wait in Awaiting Stripe payment. Amount or currency mismatches always go to Stripe payment on hold.

Advanced

Logging: writes Stripe requests and webhooks to logs/strg_debug.log.php in the module folder. The file cannot be opened from the web. Keys and customer data are not logged. Default: off. Nothing is written while it is off.

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

Delete Data on Uninstall: when on, uninstalling the module removes the gateway settings and the log. The Stripe transactions and refunds and the module's order statuses always stay, so existing orders keep working. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default Stripe) and sees the note You will be redirected to Stripe to complete the payment securely. After confirming, the module creates a Stripe Checkout Session for the cart total in the cart currency and sends the customer to the Stripe payment page. There the customer pays by credit or debit card. The customer's e-mail is passed to Stripe, and the payment shows on the Stripe page as Cart # and the cart number. No order exists yet at this point.

After paying, the customer returns to your shop. The order is marked paid only after Stripe confirms it: by the signed webhook or by a server-side request to Stripe when the customer comes back. The order is then created and the customer sees the standard order confirmation page with Your payment with Stripe has been received. For a delayed payment the page shows Your payment is being confirmed by Stripe. You will receive an e-mail as soon as it is confirmed. If a delayed payment later fails, the page shows Your Stripe payment was not completed. Please contact us about this order. If Stripe has not confirmed the payment yet when the customer comes back, a Payment confirmation page shows the same text and a Check again button; the webhook creates the order as soon as it arrives.

If the customer cancels on the Stripe page, the Stripe session is closed and the customer is back at checkout with The payment was cancelled. You can try again or choose another payment method. If the payment was not completed, the message is The payment was not completed. You can try again or choose another payment method. The cart is kept. Each new attempt closes the previous Stripe session, so the cart cannot be paid twice. If the previous session turns out to be paid already, the order is created instead of a new payment.

If Stripe cannot start the payment, the customer stays at checkout with a short message, for example The order total is below the minimum amount Stripe can charge in this currency. Please choose another payment method. The technical reason is written to the log.

If a voucher in the cart stops being valid between the payment and its confirmation, PrestaShop removes it from the order. The order then goes to Stripe payment on hold with a note, because the customer paid the price with the discount.

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

The module takes card payments only, captured immediately on the Stripe page. It has no saved cards, subscriptions or recurring payments, no on-site card form, no Apple Pay or Google Pay buttons on your site and no separate authorize and capture.

Orders and refunds

Order statuses

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

Payment accepted, Delivered or Stripe payment on hold: the payment was confirmed. The status follows Order Status After Payment. The payment is recorded with the Stripe payment ID (pi_...) as the transaction ID, and a note shows the Stripe payment, the session and how it was confirmed (webhook or return).

Awaiting Stripe payment: the customer finished the checkout with a delayed payment method. The order moves to the paid status when Stripe confirms the payment.

Stripe payment on hold after payment: Stripe reported a different amount or currency than the order total (for example, the cart was changed after the payment started), a voucher was removed, or the payment arrived after the order had been cancelled. The note explains it. Check the order and fulfil it or refund the payment.

Payment error: a delayed payment failed.

Refunded: the payment was fully refunded through the module.

If a second payment arrives for an order that is already paid, the order is not changed. A note asks you to check it and refund the duplicate in the Stripe Dashboard.

Stripe payment block

The order page shows a Stripe payment block with the Stripe payment ID (linked to the payment in the Stripe Dashboard), the Checkout Session, the payment status, the amount Stripe charged and the amount refunded, a Test mode badge for test payments, the refund history and the Stripe notes of the order.

Refunds

In the Stripe payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via Stripe. Confirm the question Refund this amount through Stripe? This cannot be undone. Full and partial refunds are supported. You need the right to edit orders. Refunds are made in the amount and currency Stripe charged, so after an amount or currency mismatch you can refund up to what the customer actually paid, not the order total. The refund is sent in the mode the payment was made in (test or live), so that mode's secret key must be set. If Stripe 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 Stripe refund ID. A full refund sets the order to Refunded. A partial refund does not change the status. Refunds are available once Stripe has confirmed the payment.

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

Refunds made in the Stripe Dashboard arrive by the charge.refunded webhook and are added to the notes with the total refunded in Stripe. The order status and credit slips are not changed automatically. Update them manually if needed.

License key

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

Stripe does not appear at checkout: check that the license is active, Enable/Disable is on and the current mode has a secret key: Test Secret Key in test mode, Live Secret Key in live mode. The settings page shows a warning when the key 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: the webhook is not working. In the Stripe Dashboard check that the endpoint exists in the mode you use (test or live), that its URL is exactly the one shown in Endpoint URL and that the four events are selected. Check that the signing secret of that endpoint is in the matching field (Test Webhook Secret or Live Webhook Secret). The Stripe Dashboard shows the answer of your shop for each webhook. The order is also created when the customer returns to the shop after paying.

Webhook answers Webhook secret not configured: neither webhook secret is set. Paste the signing secret into the settings.

Webhook answers Invalid signature: the signing secret belongs to another endpoint or another mode, or the server clock is wrong. Stripe signatures are accepted within 5 minutes of the server time. The answer is also Invalid signature when an event of a live payment is signed with the test secret or the other way round: check that the test and live secrets are not swapped.

Webhook answers Busy, retry: the order was being confirmed by another request at the same moment, or the order could not be created (for example, the module is disabled). Stripe retries the webhook automatically. Turn on Logging to see the reason.

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

The value does not look right warning on save: a key was pasted into the wrong field. Secret keys start with sk_test_ / rk_test_ or sk_live_ / rk_live_, webhook secrets with whsec_.

The customer sees an error when choosing Stripe: turn on Logging and look at the Log field on the module page. A wrong key gives the message that the payment method is not configured correctly. An order total below the Stripe minimum for the currency (for example 0.50 EUR) cannot be paid with Stripe.

Test payments do not confirm a live payment: test and live payments are kept apart. Switch Test Mode to the mode you want and use that mode's keys and webhook.

Order is Stripe payment on hold after payment: read the notes in the Stripe payment block (see Order statuses), then fulfil 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 set. Enter it and try again.

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox Stripe Gateway and choose Uninstall. The license key and license status of this module are always removed. If Delete Data on Uninstall is on, the gateway settings and the log are removed. If it is off, all settings are kept for a later re-install. The Stripe transactions and refunds and the order statuses Awaiting Stripe payment and Stripe 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.

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