VibeFox SimplePay for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

Shop currency: HUF, EUR or USD. SimplePay does not accept other currencies, and the payment method is not offered for carts in them.

SimplePay merchant accounts: SimplePay gives a separate merchant account for each currency, and separate accounts for live and sandbox. For each account you need its MERCHANT and SECRET KEY from the SimplePay merchant admin (admin.simplepay.hu for live, sandbox.simplepay.hu for sandbox), account > Technical data. If you sell only in HUF, the HUF account is enough. No other keys are needed.

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 SimplePay 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. Enter the MERCHANT and SECRET KEY of your SimplePay accounts for every currency you sell in: sandbox accounts for testing and live accounts for real payments (see Configuration).

5. Copy the IPN URL shown on the Configure page into every merchant account (live and sandbox) in the SimplePay merchant admin.

6. Turn on Enable/Disable and click Save. Test a payment with Sandbox mode on, then turn off Sandbox mode to take real payments.

On install the module creates the order status SimplePay 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 SimplePay Gateway > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page warns you when the default currency of the shop is not supported by SimplePay, or when it has no merchant account in the current mode. In both cases the payment method is not offered for carts in that currency. While sandbox mode is on, the page shows Sandbox mode is on: payments go to the SimplePay sandbox, no real money is charged.

SimplePay (OTP)

Enable/Disable: Enable SimplePay 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: SimplePay (Card Payment). Required.

Description: the text shown under the payment method at checkout. Default: Pay securely with your credit or debit card via SimplePay. Hungarian merchants can put the SimplePay data transfer declaration (with its link) here.

Sandbox mode: uses the SimplePay sandbox for test payments with the sandbox accounts. It switches both the API address and the merchant accounts. No real money is charged. Default: on. Turn it off to take real payments with the live accounts. While it is on, customers see Sandbox mode: no real payment is taken. under the payment method. Orders started in the sandbox are always refunded in the sandbox.

Live merchant accounts

The accounts used when Sandbox mode is off. Fill in the accounts of the currencies your shop sells in. The MERCHANT and SECRET KEY values are in the SimplePay merchant admin (admin.simplepay.hu), account > Technical data. An account is used only when both fields are filled in.

HUF account — Merchant ID: the MERCHANT of your live HUF account.

HUF account — Secret key: the SECRET KEY of your live HUF account.

EUR account — Merchant ID and EUR account — Secret key: the same for your live EUR account.

USD account — Merchant ID and USD account — Secret key: the same for your live USD account.

Sandbox merchant accounts

The accounts used when Sandbox mode is on. The fields are the same as for the live accounts: HUF account — Merchant ID, HUF account — Secret key and the same pairs for EUR and USD. Take the values from the SimplePay sandbox merchant admin (sandbox.simplepay.hu), account > Technical data.

Saved secret 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.

IPN URL

The IPN is the message SimplePay sends to your shop when the payment status changes. It is the regular way an order is created. The section shows the IPN URL of your shop. With friendly URLs it looks like https://your-shop/module/wcp_simplepay_gateway/ipn, possibly with a language code such as /en/. Set this URL for every merchant account, live and sandbox, in the SimplePay merchant admin. Copy the URL exactly as the settings show it, because a redirected IPN is lost.

The IPN must be signed with the SECRET KEY of the merchant account it names, in the mode (sandbox or live) the payment was started in. IPNs without a valid signature are rejected. The module confirms each valid IPN to SimplePay in the signed form SimplePay requires. These IPN statuses are used:

FINISHED: the payment succeeded. The order is created after the amount and currency check.

NOTAUTHORIZED, FRAUD: the payment was rejected. The payment attempt is marked failed; no order is created.

TIMEOUT, CANCELLED: the payment time expired or the customer cancelled. The payment attempt is marked timed out or cancelled; no order is created.

Rejected, cancelled and timed-out statuses are recorded only for the latest payment attempt of a cart that has no order yet. Other statuses are logged and change nothing. Without the IPN, an order is created only when the customer comes back to the shop after a successful payment.

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

Orders

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

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

Completed (Delivered): every paid order becomes Delivered.

A payment for another amount or currency than the order always goes to SimplePay payment on hold.

Advanced

Logging: writes API calls, IPNs and returns to logs/simplepay_op_debug.log.php in the module folder. The file cannot be opened from the web. Keys and customer data are not logged. Errors are always logged, even when this is off. 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, uninstalling the module removes the gateway settings and the log. Order data (SimplePay transactions and refunds) is always kept. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default SimplePay (Card Payment)) and sees the note You will be redirected to the SimplePay payment page to pay by card. After confirming, the module starts a SimplePay card payment for the cart total in the cart currency, with the merchant account of that currency in the current mode, and sends the customer to the SimplePay payment page. The customer's e-mail and, when it is complete, the invoice address are passed to SimplePay. The payment page uses the language of the shop when SimplePay supports it, otherwise English. A started payment can be paid within 30 minutes. No order exists yet at this point.

After a successful payment the customer returns to your shop. The return alone never pays an order: the module asks SimplePay for the status of the transaction with a signed request, so the order is created even if the IPN is late. The order is marked paid only after SimplePay confirms it. The customer then sees the standard order confirmation page with Successful transaction. SimplePay transaction ID: and the ID. If SimplePay has not confirmed the payment yet, a Payment confirmation page shows Your payment is being confirmed by SimplePay. SimplePay transaction ID: with the ID and a Check again button; the IPN creates the order as soon as it arrives.

If the payment fails, is cancelled or times out, the customer is sent back to the checkout with SimplePay's message and the transaction ID, for example Cancelled payment. You cancelled the payment or Timeout. The time allowed to complete the payment has expired. A failed payment asks the customer to check the entered data and contact the card-issuing bank. The cart is kept and the customer can try again. Each new attempt gets its own SimplePay reference: PS, the cart number and the attempt number, for example PS123-1, PS123-2.

If SimplePay cannot start the payment, the customer sees The SimplePay payment could not be started. Please try again or choose another payment method. If the cart currency has no merchant account, the message is SimplePay is not available for the currency of this order. Please choose another payment method. The technical reason is written to the log.

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

The module takes one-time card payments only, captured on the SimplePay page. It has no saved cards or one-click payments, no subscriptions or recurring payments, and no separate authorize and capture.

Orders and refunds

Order statuses

No order yet: the customer was sent to SimplePay and has not paid, the payment failed, was cancelled or timed out, or SimplePay 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 SimplePay transaction ID, and a note shows the transaction ID and whether the IPN or the status request confirmed it.

SimplePay payment on hold: the cart total or currency was changed after the payment was started, so the paid amount differs from the order. No payment is recorded. The note shows both amounts. Check the order and fulfil it or refund the payment in the SimplePay merchant admin. If another attempt of the same cart is then paid for the right amount, the order moves to the paid status.

Refunded: the payment was fully refunded through the module.

A paid, refunded or delivered order is never re-opened by a late IPN. If a second payment succeeds for an order that is already paid, the order is not changed. A note asks you to check it in the SimplePay admin and refund it if it is a duplicate.

SimplePay payment block

The order page shows a SimplePay payment block with the transaction ID, the order reference (orderRef), the merchant account and mode, the SimplePay status, the amounts paid and refunded, a Sandbox badge for sandbox payments, the payment attempts of the cart (when there was more than one), the refund history and the SimplePay notes of the order.

Refunds

In the SimplePay payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via SimplePay (OTP). Confirm the question Refund this amount via SimplePay? 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. HUF refunds must be whole forints. The refund is sent for the SimplePay transaction that paid the order, in its amount and currency, with the merchant account and in the mode (sandbox or live) of that payment, so that account must still be in the settings. If SimplePay 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 SimplePay refund transaction ID and the reason, if you entered one. A full refund sets the order to Refunded. A partial refund does not change the status. An order on hold after an amount mismatch cannot be refunded from the block: refund it in the SimplePay merchant admin.

The module does not create credit slips. The standard PrestaShop refund buttons of the order page do not send money back through SimplePay. Refunds made in the SimplePay merchant admin are not synced to PrestaShop. Record them manually.

License key

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

SimplePay does not appear at checkout: check that the license is active, Enable/Disable is on, the cart currency is HUF, EUR or USD, and that currency has both Merchant ID and Secret key in the current mode: the sandbox accounts while Sandbox mode is on, the live accounts while it is off. 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 IPN did not reach the shop. In the SimplePay merchant admin check the IPN URL of the merchant account you use (live or sandbox, the currency of the cart). It must be exactly the URL shown in the settings, and your server must be reachable from the internet. The order is also created when the customer returns to the shop after paying.

IPN answers Invalid signature: the IPN names a merchant account that is not in the settings, its Secret key is wrong, or it is signed by the account of the other mode than the payment. Enter the MERCHANT and SECRET KEY exactly as the SimplePay merchant admin shows them. SimplePay repeats unconfirmed IPNs.

IPN answers Order not found or Unknown transaction: the IPN is for a payment that this shop did not start. Nothing is changed.

IPN answers Busy, retry: the cart was being processed by another request at the same moment, or the order could not be created (for example, the module is disabled). SimplePay retries the IPN. The reason is written to the log.

The customer sees The SimplePay payment could not be started: look at the Log field on the module page. A wrong secret key gives Invalid response signature from SimplePay. Check the secret key of the merchant account. SimplePay errors are logged with their error codes.

After switching between sandbox and live: new payments use the accounts of the new mode. Payments started before keep the merchant account and mode they were started with: their IPNs, status requests and refunds use that account. Keep the accounts of the old mode in the settings while such payments are open or may be refunded.

Order is SimplePay payment on hold after payment: read the notes in the SimplePay payment block. The cart total or currency was changed after the payment was started. Fulfil the order or refund the payment in the SimplePay merchant admin.

Refund fails: read the message in the block. SimplePay refunds in HUF must be whole amounts. means the HUF amount had decimals. If the message says the merchant account of this payment is not configured, enter the account (currency and mode) the payment was made with again. If SimplePay refunded a different amount, the message asks you to check the refund in the SimplePay admin.

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox SimplePay 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 SimplePay transactions and refunds and the order status SimplePay 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.

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