VibeFox MakeCommerce for Adobe Commerce — ヘルプ

Requirements

Magento: Magento Open Source or Adobe Commerce 2.4.6 to 2.4.9, on your own server or hosting, on premises or on Adobe Commerce on cloud infrastructure. The module does not work with Adobe Commerce as a Cloud Service (the SaaS edition), which does not accept PHP modules.

PHP: 8.1 to 8.4.

Internet access to your store: MakeCommerce sends payment notifications to your store, so the site must be reachable from the internet. A firewall or basic authentication can 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

The module is one ZIP file. It is a Composer package and can also be copied into app/code. Run the commands in the Magento root folder as the user that owns the Magento files.

1. With Composer: put the ZIP file into a folder that your project uses as a Composer "artifact" repository and run composer require vibefox/module-makecommerce-payment. Without Composer: unpack the ZIP file into app/code/Vibefox/MakecommercePayment/, so that registration.php is directly in that folder.

2. Run bin/magento module:enable Vibefox_MakecommercePayment and bin/magento setup:upgrade. In production mode also run bin/magento setup:di:compile and bin/magento setup:static-content:deploy, then bin/magento cache:flush.

3. In the Admin go to Stores > Configuration > Sales > Payment Methods and open VibeFox MakeCommerce Payment. When the Magento PayPal module is enabled, the group is listed under Other Payment Methods. Paste your VibeFox license key into License key in the license block, the first row of the group, 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. Set Enable to Yes and click Save Config. Test a payment with Test Mode = Yes, then set it to No to accept real payments.

The module adds the Bank link or card (MakeCommerce) payment method to the Magento checkout. It is off after installation (Enable = No). The module uses the standard Magento order states and creates no order statuses of its own. It creates two tables for the MakeCommerce transactions and refunds.

Configuration

All settings are in Stores > Configuration > Sales > Payment Methods > VibeFox MakeCommerce Payment, in the standard Magento configuration form. Like other Magento settings, they can be changed for a website with the Scope switcher at the top of the page; Title and Description also for a store view. Remove data on uninstall is read from the Default Config only. Save Config saves the whole page. Amounts accept "9.99" and "9,99". The group is one list of fields; below they are described in groups, in the order of the page.

If a value is wrong, Magento shows an error and nothing on the page is saved: an empty Title or a title longer than 128 characters (Enter a title for the payment method (up to 128 characters).); a Sort Order that is not a whole number; a Minimum Order Total or Maximum Order Total that is not a number of 0 or greater.

While Enable is Yes, the Callback URLs and setup row warns Enter the Shop ID and Secret key for the current environment, otherwise MakeCommerce is hidden at checkout. when a key of the current environment is missing, The store currency has more than two decimals and cannot be charged by MakeCommerce. and, while test mode is on, Test Mode is enabled. No real money is charged.

General

Enable: shows or hides MakeCommerce at checkout. It is shown only when the Shop ID and Secret key of the current environment are set. Default: No.

Title: the payment method name customers see at checkout. It is also stored in the order. Default: Bank link or card (MakeCommerce). Required, at most 128 characters.

Description: the text shown under the payment method when the customer selects it 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 Callback URLs and setup row has links to the Test Merchant Portal and the Live Merchant Portal.

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: Yes.

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.

Clear test secret key: set it to Yes and click Save Config to remove the saved test Secret key. It goes back to No after saving.

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

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

Clear live secret key: set it to Yes and click Save Config to remove the saved live Secret key. It goes back to No after saving.

Magento stores the Secret keys encrypted and shows only a mask (******) after saving. Leave the mask, or leave the field empty, to keep the saved key (Leave blank to keep the saved secret. Use Clear to remove it.). Type a new value to change it. Spaces are removed from the Shop IDs and keys on save.

Conditions

Payment from Applicable Countries: All Allowed Countries offers MakeCommerce for every country your store allows, Specific Countries only for the countries below.

Payment from Specific Countries: offer MakeCommerce only for billing addresses in these countries.

Minimum Order Total: offer MakeCommerce only from this order total, in the base currency of your store. Empty or 0 means no minimum.

Maximum Order Total: offer MakeCommerce only up to this order total, in the base currency. Empty or 0 means no maximum.

Sort Order: the position among the payment methods at checkout. A whole number. Default: 0.

Payment notifications

Nothing has to be configured in the Merchant Portal. The Callback URLs and setup row shows, for reference, the address for the customer's return or cancel (looks like https://your-store/wcpmakecommercepayment/checkout/back) and the address for payment notifications (https://your-store/wcpmakecommercepayment/webhook/index). Every transaction carries its own return, cancel and notification URLs, built on the storefront of the order with the order number and a secret token of the payment attempt. 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 store. If the customer comes back without a signed message, the module asks the MakeCommerce API for the status.

Advanced

Debug log: writes MakeCommerce API calls and payment notifications to var/log/wc_mkc_debug.log.php in the Magento folder. The file cannot be opened from the web. Errors and warnings are always logged. Shop IDs, keys, e-mail addresses and tokens are masked, request bodies are not logged. Default: No.

Remove data on uninstall: when Yes, uninstalling the module with its data deletes the module settings and the log (see Uninstall). Order, transaction and refund history is always retained. Default: No.

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

Checkout

At the payment step the customer chooses the payment method (by default Bank link or card (MakeCommerce)) and sees its description. After Place Order, Magento places the order in Pending Payment. No invoice is created and no order e-mail is sent yet. The module then creates a MakeCommerce transaction for the order total in the order currency, with the reference MG- and the cart number, and sends the customer to the MakeCommerce payment page. There the customer chooses a bank link or a card. The customer's e-mail, country and IP address are passed to MakeCommerce, and the page opens in the store language when MakeCommerce supports it (Estonian, English, Latvian, Lithuanian, Finnish, Russian, German, Polish), otherwise in English.

After paying, the customer returns to your store. 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. Magento then creates the invoice with the MakeCommerce transaction ID, sets the order to Processing and sends the order e-mail. The customer sees the standard order success page. If the order went on hold for review, the success page shows Your MakeCommerce payment is being reviewed by the shop. Do not pay again. A customer who comes back in another browser lands on the home page with Your payment status was checked. Sign in or contact the shop to view your order.

If the payment is 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 confirms the order as soon as the payment is completed.

If the customer cancels on the MakeCommerce page, or the payment expires or fails, the order is cancelled (the stock goes back), the cart is restored and the customer is back in the cart with The payment was cancelled, expired or failed. You can try again or choose another payment method. Each new attempt is a new order and a new MakeCommerce transaction. A cart cannot be paid twice: while another payment of the same cart is paid or awaiting verification, the customer sees This cart already has a payment awaiting verification. Do not pay again.

If MakeCommerce refuses to start the payment, the order is cancelled, the cart is restored and the customer sees MakeCommerce could not start the payment. Please try another payment method. If the answer of MakeCommerce is unclear (for example a timeout), the order stays in Pending Payment, the transaction is not created again automatically, and the customer gets the Payment confirmation page. The technical reason is written to the log.

When an order in Pending Payment is cancelled in Magento, by you or by the Magento cron after the Pending Payment Order Lifetime (Stores > Configuration > Sales > Sales > Orders Cron Settings), the MakeCommerce transaction is not closed, because MakeCommerce has no cancel request. If the customer still pays it, the order is not reopened: a note asks for review (see Order statuses).

The module works with the standard Magento checkout. 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). MakeCommerce is not offered for orders created in the Admin.

Orders and refunds

Order statuses

Pending Payment: the order was placed and the customer was sent to MakeCommerce, but MakeCommerce has not confirmed the payment yet. There is no invoice.

Processing: the payment was confirmed. The invoice is created with the MakeCommerce transaction ID as the transaction ID, and a note shows how the payment was confirmed (signed notification, signed return or API status check).

On Hold: the payment needs your review. The note MakeCommerce payment requires review explains why: the paid amount or currency differs from the order, the amount was missing, the transaction at MakeCommerce does not belong to the order, or the transaction was reported as completed but the MakeCommerce API does not show it as completed yet. No invoice is created. A transaction that was not final yet completes the order when MakeCommerce reports it as completed. A mismatch never pays the order later: check the transaction in the Merchant Portal, then fulfil the order or refund the payment.

Canceled: the customer cancelled the payment, or it expired or failed, MakeCommerce refused to start it, or the order was cancelled in Magento. If a payment arrives for a cancelled or closed order, the order is not reopened, and the note asks for review.

Closed: the payment was fully refunded with a credit memo.

If a second payment arrives for an order that is already paid, or another order of the same cart already holds a payment, the order is not changed. A note asks you to check it and refund the duplicate in the Merchant Portal. The notes are order comments that the customer does not see.

MakeCommerce payment information

On the admin order page (Sales > Orders > View) the payment information shows the payment method title and MakeCommerce transaction, MakeCommerce mode (test or live), MakeCommerce status, MakeCommerce result and the MakeCommerce refund history. The customer sees only the payment method title.

The Information tab of the order also has the MakeCommerce transactions section with all MakeCommerce transactions of the cart (transaction ID, mode, MakeCommerce status and result) and the button Check MakeCommerce payment status. It asks the MakeCommerce API for the status of the cart's latest transactions, applies it and adds a note with the result. Use it when a customer says they paid but the order was not confirmed. The button needs the right to edit orders.

Refunds

Open the order, go to the Invoices tab, open the invoice and click Credit Memo. Choose the items and amounts to refund and click Refund. The money is sent back through MakeCommerce. Full and partial refunds are supported. A credit memo started from the order page instead of the invoice offers only Refund Offline, which does not send money back through MakeCommerce.

The refund is made in the order currency, up to the amount MakeCommerce charged minus the amounts already refunded. It is sent to the environment the payment was made in (test or live), so that environment's keys must be set. The credit memo comment is sent to MakeCommerce as the refund comment (up to 200 characters); without a comment it is Refund for order and the order number. If MakeCommerce does not accept the refund, Magento shows the error and the credit memo is not created. If MakeCommerce is still processing the payment, the message is MakeCommerce is still processing this payment. Try the refund again later. After a successful refund Magento records it on the order with the MakeCommerce refund ID as the transaction ID. A full refund closes the order. Refunds are available once MakeCommerce has confirmed the payment and the order has an invoice.

If the answer of MakeCommerce to a refund is unclear, for example a timeout, the error is The MakeCommerce refund outcome is unknown. Check the Merchant Portal before trying again. Further online refunds of the order are blocked, so the money cannot be sent twice. Check the refund in the Merchant Portal.

Charges without an invoice: when a payment was received but no invoice was created (On Hold after a mismatch or a payment after cancellation), the MakeCommerce transactions section shows This charge has no paid invoice. Its actual amount can be refunded without creating a Credit Memo. Enter the Refund amount (the amount not refunded yet is filled in) and optionally a Reason, and click Refund uninvoiced charge. The refund is limited to the amount actually paid. A note is added; a full refund cancels the order. The form needs the right to create credit memos.

Refunds made in the Merchant Portal arrive with the transaction status and are added to the order notes. The order and credit memos are not changed automatically. Create a credit memo with Refund Offline or update the order manually if needed.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox MakeCommerce Payment is the first row of the VibeFox MakeCommerce Payment group in Stores > Configuration > Sales > Payment Methods, 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 store. Below them are the line Product: magento-payment-makecommerce and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only Admin users whose role allows the Payment Methods configuration section can change the key. The texts of the block follow the Admin interface locale (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 store 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 default store view, also when the installation has several websites or stores. Removing the key from the store 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 order is cancelled, the cart is restored and the customer sees This payment method is not available. Please choose another one. The Magento storefront does not know that you are logged in to the Admin, 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 the System Messages of the Admin, with the links Enter the license key and Dismiss, which hides it for 7 days. 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: once a day for the first 14 days after the key is entered, then once a week, by the Magento cron and while you work in the Admin. Uninstalling the module with its data always removes the license key and license status.

Troubleshooting

MakeCommerce does not appear at checkout: check that the license is active and Enable is Yes for the website of the store, and that 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. The Callback URLs and setup row shows a warning when a key is missing. Check that the order currency has at most two decimals. Check Payment from Applicable Countries and Payment from Specific Countries against the customer's billing address, and Minimum Order Total and Maximum Order Total.

The payment went through, but the order stays Pending Payment: the notifications could not reach the store, for example because of a firewall or basic authentication. Magento maintenance mode also closes the notification URL. The order is also confirmed when the customer returns to the store or clicks Check again, and when you click Check MakeCommerce payment status on the order page. 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 On Hold: read the order notes (see Order statuses), check the transaction in the Merchant Portal, then fulfil the order or refund the payment. A charge without an invoice can be refunded with Refund uninvoiced charge.

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

The notification URL shows ERROR in the browser: this is normal. The URL accepts only signed messages from MakeCommerce.

The customer is back in the cart with an error after Place Order: turn on Debug log and look at the Log field in the settings. A wrong key or a currency MakeCommerce cannot charge stops the payment. The order of that attempt is cancelled.

Refund fails with Configure the keys of the environment used for this payment: the order was paid in the test or live environment, and the keys of that environment are not set. Enter them and try again.

Refund fails with The MakeCommerce refund journal needs reconciliation before another online refund: a refund of this order was made outside the module or is still unclear. Check the refunds in the Merchant Portal and record the rest with Refund Offline.

The Refund button is missing on the credit memo: start the credit memo from the invoice (Invoices tab), not from the order page. An order without an invoice (for example On Hold after a mismatch) cannot be refunded with a credit memo; use Refund uninvoiced charge in the MakeCommerce transactions section.

The settings page or the checkout looks unchanged after installing or updating: run bin/magento setup:upgrade and bin/magento cache:flush; in production mode also setup:di:compile and setup:static-content:deploy.

Uninstall

Deleting the module code alone removes nothing from the database: the license key and the settings stay. To remove the data, uninstall the module with the Magento command:

Installed with Composer: run bin/magento module:uninstall --remove-data Vibefox_MakecommercePayment. It removes the data and the code.

Installed in app/code: run bin/magento module:uninstall --non-composer Vibefox_MakecommercePayment to remove the data, then bin/magento module:disable Vibefox_MakecommercePayment, delete the folder app/code/Vibefox/MakecommercePayment and run bin/magento setup:upgrade.

The license key and license status are always removed. If Remove data on uninstall is Yes, the module settings and the log are removed too. If it is No, the settings are kept for a re-install. The MakeCommerce transactions and refunds are always kept, so orders paid before can still be refunded after a re-install. Existing orders keep their invoices, payment notes and transaction IDs.

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