VibeFox MakeCommerce for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

Internet access to your shop: MakeCommerce sends payment notifications to your shop, so the site must be reachable from the internet. A firewall or basic authentication can block them. Maintenance mode and the country restriction of your shop do not block them.

MakeCommerce account: you need the Shop ID and Secret key from the MakeCommerce Merchant Portal (Settings > API). The test and live environments have separate accounts and keys. Which payment methods and currencies are available is defined by your MakeCommerce contract. Currencies with three decimals, such as KWD or BHD, are not offered.

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 MakeCommerce 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 Shop ID and Secret key of the test environment and, for real payments, the live keys (see Configuration). Nothing has to be configured in the Merchant Portal.

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 MakeCommerce 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 MakeCommerce Payment > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page shows Test mode is on: payments are created in the MakeCommerce test environment and no real money is charged. while test mode is on. It warns you when the method is enabled but the Shop ID or Secret key of the current environment is empty, and when the default currency of the shop cannot be charged by MakeCommerce. In both cases the method is hidden at checkout. Spaces are removed from the keys on save.

MakeCommerce

Enable/Disable: Enable MakeCommerce payments 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: Bank link or card (MakeCommerce). Required.

Description: the text shown under the payment method at checkout. Default: Pay with your Estonian, Latvian, Lithuanian or Finnish bank, or by card. You will be redirected to the secure MakeCommerce payment page.

MakeCommerce account

The Shop ID and Secret key are in the MakeCommerce Merchant Portal under Settings > API. The test portal and the live portal have separate accounts and keys. The section has links to both portals and to the MakeCommerce sign-up page.

Test mode: uses the MakeCommerce test environment (no real money is charged). New payments are created in the selected environment with its keys. Every order remembers the environment it was paid in: status checks and refunds always go there. While it is on, customers see TEST MODE — MakeCommerce test environment, no real money is charged. under the payment method. Default: on.

Test Shop ID: the Shop ID of your test account, in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Test Secret key: the Secret key of your test account.

Live Shop ID: the Shop ID of your live account.

Live Secret key: the Secret key of your live account.

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.

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

Payment notifications

Nothing has to be configured in the Merchant Portal. Callback URLs shows, for reference, the address for the customer's return or cancel and the address for payment notifications. Every transaction carries its own return, cancel and notification URLs, based on these addresses with the cart number and a key added. MakeCommerce sends a signed message to the notification URL (server to server) and with the customer's browser to the return or cancel URL. The signature is checked with the Secret key of the environment the transaction was created in. Messages without a valid signature are rejected.

The module handles these MakeCommerce transaction statuses:

The payment is also confirmed when the customer returns to the shop. If the customer comes back without a signed message, the module asks the MakeCommerce API for the status.

Advanced

Debug log: logs API calls and payment notifications to logs/wc_mkc_debug.log.php in the module folder. The file cannot be opened from the web. Errors are always logged. Keys 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: when on, uninstalling the module removes the module settings and the log. Orders and their MakeCommerce payment data are always kept. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default Bank link or card (MakeCommerce)) and confirms. The module creates a MakeCommerce transaction for the cart total in the cart currency and sends the customer to the MakeCommerce payment page. There the customer chooses a bank link or a card. The customer's e-mail and country are passed to MakeCommerce, and the page opens in the shop language when MakeCommerce supports it (Estonian, English, Latvian, Lithuanian, Finnish, Russian, German, Polish), otherwise in English. No order exists yet at this point.

After paying, the customer returns to your shop. The order is marked paid only after MakeCommerce confirms it: by the signed notification or by the signed return of the customer, with a check of the transaction through the MakeCommerce API. The order is then created and the customer sees the standard order confirmation page with Your MakeCommerce payment has been received. If the order went on hold for review, the page shows Your MakeCommerce payment was received and is being reviewed by the shop.

If the payment is approved but not completed yet, or MakeCommerce cannot be reached, a Payment confirmation page shows We could not confirm your payment yet. If you completed it, your order will be updated automatically — please do not pay again. with the buttons Check again and Back to checkout. The notification creates the order as soon as the payment is completed.

If the customer cancels on the MakeCommerce page or the payment expires or fails, the customer is back at checkout with a message, for example The payment was cancelled. You can try again or choose another payment method., The payment session expired. Please try again. or The payment was not completed. Please try again or choose another payment method. The cart is kept, and the customer can pay again. Each attempt is a new MakeCommerce transaction. An older payment link of the same cart still works, and the cart cannot be paid twice into two orders.

If MakeCommerce cannot start the payment, the customer stays at checkout with MakeCommerce is temporarily unavailable. Please try again in a moment or choose another payment method. or MakeCommerce could not start the payment for this order. Please choose another payment method or contact us. The technical reason is written to the log.

The bank or card is chosen on the MakeCommerce page, not in your checkout. The module has no saved cards, recurring payments or subscriptions and no MakeCommerce shipping (parcel machines, labels).

Orders and refunds

Order statuses

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

Payment accepted: the payment was confirmed. The payment is recorded with the MakeCommerce transaction ID, and a note shows the amount, the transaction, the environment and how it was verified (MakeCommerce API or signed notification).

MakeCommerce payment on hold: the paid amount or currency differed from the cart (for example, the cart was changed after the payment started), the amount was missing, the transaction at MakeCommerce was not final yet although reported as completed, or the payment arrived after the order had been cancelled. The note explains it. If the paid currency is the order currency, the amount actually paid is recorded on the order. A transaction with a mismatch never pays the order later; a transaction that was not final yet completes the order when MakeCommerce reports it as completed. Check the transaction in the Merchant Portal and fulfil the order or refund the payment.

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 refund the duplicate in the MakeCommerce Merchant Portal.

MakeCommerce payment block

The order page shows a MakeCommerce payment block with all MakeCommerce transactions of the cart (date, transaction ID, a Test badge for test payments, amount, MakeCommerce status and result), the paid and refunded amounts, the refund history and the MakeCommerce notes of the order. The buttons of the block need only the right to edit orders, not access to the modules.

Check MakeCommerce payment status: asks the MakeCommerce API for the status of the cart's transactions (the latest first), applies it and adds a note with the result. Use it when a customer says they paid but the order was not completed.

Refunds

In the MakeCommerce payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via MakeCommerce. Confirm the question Refund this amount via MakeCommerce? Full and partial refunds are supported. Refunds are limited to the amount and currency of the MakeCommerce transaction, so after an amount mismatch you can refund up to what the customer actually paid, not the order total. The refund is sent to the environment the payment was made in (test or live), so that environment's keys must be set. The reason is sent to MakeCommerce as the refund comment; without a reason the comment is Refund for order and the order reference. If MakeCommerce does not accept the refund, the block shows the error, a note is added and no refund is recorded. If MakeCommerce is still processing the payment, the message is MakeCommerce is still processing this payment — try the refund again later. A successful refund is added to the refund history and the notes with the MakeCommerce refund ID. A full refund sets the order to Refunded. A partial refund does not change the status. Refunds are available once MakeCommerce 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 MakeCommerce.

Refunds made in the Merchant Portal arrive with the transaction status and are added to the notes. The order status and credit slips are not changed automatically.

License key

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

MakeCommerce does not appear at checkout: check that the license is active, Enable/Disable is on and the current environment has its keys: Test Shop ID and Test Secret key in test mode, Live Shop ID and Live Secret key in live mode. Check that the cart currency has at most two decimals. 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 notifications could not reach the shop, for example because of a firewall or basic authentication. The order is also created when the customer returns to the shop or clicks Check again. Check that the keys of the environment the payment was made in are set: the notification is checked with that environment's Secret key, and without it MakeCommerce gets an error and retries. Turn on Debug log to see the notifications.

The order is MakeCommerce payment on hold: read the MakeCommerce notes in the block on the order page (see Order statuses), check the transaction in the Merchant Portal, then fulfil the order or refund the payment.

Notifications are rejected: a message with a wrong signature, for another cart, another shop or a transaction not created for the cart is rejected and nothing is changed. Check that the Shop ID and Secret key belong to the same MakeCommerce account and environment.

The customer sees an error when choosing MakeCommerce: turn on Debug log and look at the Log field on the module page. A currency MakeCommerce cannot charge gives MakeCommerce cannot process payments in and the currency code.

Refund fails with a message about the environment: the order was paid in the test or live environment, and the keys of that environment are not configured. Enter them and try again.

Refund fails with No MakeCommerce transaction ID found for this order: the order has no confirmed MakeCommerce payment. Refund it in the Merchant Portal.

Uninstall

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

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