VibeFox Cardcom for WooCommerce — Help

Requirements

WordPress: 6.0 or later.

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

PHP: 8.0 or later.

HTTPS: your site must be reachable from the internet over HTTPS, so that Cardcom can send the payment notification.

Currency: the order currency must be ILS, USD, EUR or GBP. For any other currency the payment method is hidden at checkout.

Cardcom account: for live payments you need a Cardcom merchant account with a terminal number, an API username and an API password. Payments need only the terminal number and the API username. The API password is used only for refunds from WooCommerce. Test mode works without a Cardcom account.

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

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Payments > Cardcom > 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. Turn on Enable/Disable, leave Test Mode on and place a test order with the card 4580 0000 0000 0000, any future expiry date, CVV 123.

6. For real payments untick Test Mode and enter the Terminal Number, API Username and API Password you received from Cardcom.

Configuration

All settings are on one page: WooCommerce > Settings > Payments > Cardcom. Above the fields the page shows Test mode is on. while test mode is on. In live mode it warns you when the terminal number or API username is missing (Cardcom is then hidden at checkout) and reminds you that without the API password refunds from WooCommerce are not possible. It also warns you when the store currency is not supported. When you save live mode without the terminal number or API username, an error message tells you that the gateway stays hidden at checkout until they are entered.

General

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

Title: the payment method name customers see at checkout. Default: Credit Card (Cardcom).

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

Test mode

Test mode uses the public Cardcom test terminal 1000 (API user CardTest1994). No real money is charged and no Cardcom account is needed. Test card: 4580 0000 0000 0000, any future expiry date, CVV 123. In test mode the checkout also shows a line with this test card.

Test Mode: Enable test mode (terminal 1000, no real money). Default: on. Untick it to accept real payments with the live credentials below. Refunds are always sent with the credentials of the mode the order was paid in.

Live credentials

The terminal number, API username and API password are provided by Cardcom with your merchant account: in the Cardcom dashboard under API settings, or from Cardcom support. These fields are used only in live mode.

Terminal Number: your Cardcom terminal number. It must contain digits only. If you enter anything else, an error is shown and the previous value is kept.

API Username: your Cardcom API username (ApiName) for this terminal. Spaces are removed on save.

API Password: your Cardcom API password. It is needed only for refunds from WooCommerce and is stored exactly as typed.

Payment page

Cardcom sends payment notifications (IndicatorUrl) to the address shown in this section. It looks like https://your-site/wc-api/cardcom_p_callback/. The address is passed to Cardcom automatically with every payment, together with the order ID, so there is nothing to configure in Cardcom. It must be reachable from the internet.

Operation: what Cardcom does on the payment page.

Max Installments: the maximum number of installments (payments) the customer can choose on the Cardcom page, from 1 to 36. 1 means no installments. Default: 1.

Success Order Status: the order status after a confirmed payment. The status is set at once, without a second status change.

Advanced

Debug log: Log API requests and notifications writes to WooCommerce > Status > Logs, source wcp_cardcom_payment_gateway. Errors are always logged. Credentials, card tokens and card-holder details are never written. Default: off.

Delete on Uninstall: Delete all plugin data when uninstalling. When on, deleting the plugin permanently removes the settings, the Cardcom data stored on orders and the logs. Orders themselves are kept. Default: off.

Checkout

The customer chooses the payment method (by default Credit Card (Cardcom)) and places the order. The plugin creates a Cardcom payment page for the order total in the order currency and sends the customer there. The page opens in Hebrew when the site language is Hebrew, otherwise in English. The order items are passed to Cardcom as the product name. The customer enters the card details and, if installments are allowed, chooses the number of payments.

After paying, the customer returns to the order received page of your store. The order is marked paid only after Cardcom confirms it. Cardcom calls the notification address, and the plugin takes from that call only the payment page code. It checks that this code was issued by your store for that order and then asks Cardcom server-to-server for the real result. If the notification is late, the same check runs when the customer lands on the order received page.

If the payment is not completed, Cardcom sends the customer back to the checkout (or the Pay for order page), which shows The card payment was not completed. Please try again or choose a different payment method. A declined payment confirmed by Cardcom marks the order Failed. The customer can pay an unpaid order again, for example from the Pay for order page. A payment made on an older payment page of the same order is still recognised. If the customer switched to another payment method but paid on the Cardcom page, the payment is recorded and the payment method is set back to Cardcom.

If Cardcom cannot open the payment page, the customer sees a short message, for example Could not connect to Cardcom. Please try again in a moment. or that Cardcom could not open the payment page, with the Cardcom code, and can choose another payment method.

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

The plugin takes card payments on the Cardcom page only. It has no saved cards or one-click payments, no subscriptions, does not charge stored tokens, has no Cardcom invoice or receipt settings, no Bit, Apple Pay, Google Pay or PayPal via Cardcom, no iframe mode and no capture-later deals. Abandoned payment pages are not checked automatically.

Orders and refunds

Order statuses

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

Processing, Completed or On Hold: the payment was confirmed. The status follows Success Order Status. The order note shows the Cardcom transaction, and, when Cardcom reports them, the last four card digits, the invoice number and the number of installments. Test payments are marked Test mode — no real money was charged. The transaction ID of the order is the Cardcom deal number.

On hold after payment: Cardcom confirmed a payment that does not match the order, for example the order total was changed after the payment page was opened, or a different sum or currency was charged. The order note explains it. Compare the payment in the Cardcom dashboard with the order, then fulfil it or refund the payment.

Failed: Cardcom declined the payment. The order note shows the Cardcom response code. A decline on an older payment page does not fail a newer attempt, and a late decline never changes a paid order.

If a second successful payment arrives for an order that is already paid (for example the customer paid in two browser tabs), the order is not changed again. A note warns that the customer may have been charged twice and asks you to refund it in the Cardcom dashboard.

Refunds

Open the order, click Refund, enter the amount and click Refund via Credit Card (Cardcom) (the button shows the payment method title). Full and partial refunds are supported, and several partial refunds can be made for one order. The refund is sent with the credentials of the mode the order was paid in: test orders are refunded on the Cardcom test terminal even after you switched to live mode, and live orders always use your live credentials. Live refunds need the API Username and API Password. If Cardcom 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 Cardcom refund transaction and the reason.

Refunds made in the Cardcom dashboard are not reported back to the store. If needed, create a manual refund in WooCommerce without Refund via the gateway.

License key

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

Cardcom does not appear at checkout: check that the license is active, Enable/Disable is on and the order currency is ILS, USD, EUR or GBP. In live mode check that Terminal Number and API Username are filled in. The settings page shows a warning when something is missing.

The payment went through, but the order stays Pending payment: Cardcom could not reach your site, for example because of maintenance mode, a firewall, password protection or a local development site. The notification address must be reachable from the internet over HTTPS. The order is also confirmed when the customer returns to the order received page. Turn on Debug log and check WooCommerce > Status > Logs, source wcp_cardcom_payment_gateway.

Notification answers Missing or invalid lowprofilecode or Unknown lowprofilecode for this order: the call did not carry a payment page code issued by your store for that order. The order is not changed.

Notification answers Gateway not configured or Indicator check failed: the credentials of the mode the payment page was created in are missing, or Cardcom could not be reached for the check. The order is not changed and is checked again when the customer returns to the store.

Notification answers ReturnValue mismatch or Terminal mismatch: Cardcom reported a payment for another order or another terminal. The order is not changed. Check that Terminal Number is the terminal of your account.

The customer sees Payment error: this currency is not supported by Cardcom.: the order currency is not ILS, USD, EUR or GBP.

The customer sees Card payment is temporarily unavailable. Please choose another payment method.: live mode is on, but the terminal number or API username is missing.

The customer sees an error when placing the order: open the order notes or turn on Debug log and look at the log. Connection problems and Cardcom error codes are written there.

Order is On hold after payment: read the order note. The paid amount or currency differed from the order. Fulfil the order or refund the payment.

Refund fails with API username and API password are required for refunds: enter the API Password (and API Username) in the settings and try again.

Refund fails with Could not connect to Cardcom: check the Cardcom dashboard before you try again, because the refund may or may not have been made.

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.

For developers, the readme lists the filter cardcom_p_supported_currencies, which extends the list of currencies (add only currencies enabled on your Cardcom terminal).

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

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