Knowledge Base / API
עברית

Ask AI

✦ AI answer

Thinking…

Sources

    Connecting and Installing the Payment Plugin for a WordPress Store – WordPress WooCommerce Payment WOO

    A complete guide to installing, configuring, and troubleshooting the Cardcom Payment Gateway plugin for WordPress WooCommerce, including payment methods, tokens, invoices, PayPal, payment statuses, and technical requirements.

    Guide to Connecting Payment Processing to a WordPress Store – WordPress WooCommerce Payment WOO

    Enables purchases through your online WordPress store using WooCommerce.

    After the plugin is installed, the payment form is displayed to the customer after they choose to pay by credit card.
    The form is displayed in the website's HTML using an IFRAME or by redirecting the customer to a new page (REDIRECT), according to your preference.


    Requirements for enabling payment processing on the website:

    • Purchase of the Low-Profile module and receipt of API access permissions for the account.

    • A WordPress website running version 6 or later.
      (In the event of a Peer's Certificate error, WordPress must be updated to version 6 or later.)


    For the website builder/developer:

    • Verify that the business has purchased the Low-Profile module (required).

    • Documents/Tokens module (optional) — update the payment plugin settings according to the requirements.


    • Also supported with Woo Subscriptions for website subscriptions.
      Guide to connecting Woo Subscriptions – settings and technical requirements.

    • Also supported with UpStroke: WooCommerce One Click Upsell for website upsells.
      Using UpStroke: WooCommerce One Click Upsell for Cardcom.


    The plugin is included in the official WordPress plugin directory.
    Plugin name: Cardcom Payment Gateway.

    • We recommend installing it from the official WordPress plugin directory.

    • If it was previously installed from another source, deactivate it, remove it completely, and then install it again.


    Activating the plugin after installation

    1. In WordPress, go to Installed Plugins, locate the plugin, and click Activate.

    2. Then go to:
      WooCommerce → Settings → Payments → click “Manage” for our plugin to configure it.


    Illustrative images:


    Plugin settings fields:


    Title (required)

    A description of the payment method as it will be displayed to the user on the website. (Required field)

    Enable/Disable (required)

    Determines whether the module is active.

    Description (required)

    Free text displayed to the user on the website.


    Operation (required) – type of operation to perform:

    1. Charge Only

    Charge only. (Requires the Low-Profile module.)

    2. Charge and Save TOKEN

    Charges the card and saves a token, allowing a returning customer to select their saved payment details instead of entering them again. If the business does not want to offer this option, it must hide it on its side.

    Token charges are performed by the developer and require a terminal that does not require CVV and ID number verification.
    (Requires the Low-Profile module and Tokens module.)

    3. Save TOKEN

    Saves a token only. Suitable for subscription websites.
    Requires a developer and the Tokens module.

    Configuration steps:

    4. Suspended Deal

    Suspends the transaction. The business manually charges the transaction through the Cardcom system, according to the Suspended Deal guide.
    (Requires the Suspended Deal module.)

    4.1 Suspended Deal - J2

    Checks the verification digit up to the issuer's authorization system, without capturing the credit framework.

    4.2 Suspended Deal - J5

    Captures the credit framework.
    Requires approval from the credit-card companies regarding the capture period.


    5. Capture Charge

    Captures the credit framework through WooCommerce.

    (Requires Tokens and J5 for the credit-card-company terminal.)

    Allows:

    • Editing the order amount in the website's administration system.

    • Charging directly through the website.

    • Updating and charging on the WooCommerce side rather than through Cardcom.

    • In the background, a token is created and charged.
      (Requires the Tokens module but does not require a terminal with CVV.)

    • Important! If the company registration number is changed when moving to a new subscription, suspended orders will be declined as soon as the new terminal is connected. All orders must be charged before entering the new terminal's API details. Alternatively, contact Developer Support with the developer to learn how to delete the approval number received for the orders (Approval Number), after which the orders can be charged normally.

    Order Status (required)

    Updates the order status after payment is completed; this is not relevant to this feature.
    In Capture Charge mode, the status will always become ON-HOLD.

    In Capture Charge mode, the actual charge is performed only when the order status is changed to completed or processing.

    Recommendation: Provide the product or service only after the transaction has actually been charged.

    Additionally, the payment form allows the cardholder to select the option to save their details for future use and automatic identification.


    Invoice (required) – Should an invoice be created with the credit-card charge?

    • Check with the business whether it has purchased the Documents module.

    • If yes, select YES.

    • If not, select Display only.
      If documents are issued by an external provider, such as Morning (Green Invoice), select YES.


    Please note:
    These operations apply only to a one-time/general customer.
    To implement the option to create customer cards, go to:

    Settings tab → 4. Low-Profile Payment Processing → 2. General Settings
    Then, under “API Override Settings”, select:
    “Create Customer Card.”

    mceclip0.png

    Terminal Number (required)

    The unique terminal number provided when the account was opened in the Cardcom system. Only one terminal number can be entered.

    API User Name (required)
    The terminal's interface user. (API keys – where to find them and how to obtain them)

    API Password (required)
    The interface user's password, used to cancel and refund transactions through WooCommerce orders. (API keys – where to find them and how to obtain them) For canceling orders, see the guide to canceling and refunding transactions and orders through the WordPress website where the Cardcom plugin is installed.
    Active only for Charge and Save TOKEN.

    Must CVV
    Determines whether the terminal requires CVV.
    If yes, when the customer returns to make a second purchase, the form will ask them to enter their CVV.

    Cvv Must Terminal Number
    Terminal number for recurring payments/without CVV verification by the credit-card company.
    This setting applies only when working with tokens and is optional.

    Max Payment
    The maximum number of installments displayed on the page.
    We recommend using installment tiers.

    Currency
    Currency type:
    0 – Automatically detected from the order
    1 – Israeli shekel
    2 – US dollar
    (Foreign currencies require approval from the credit-card companies.)

    Lang
    Interface language: he for Hebrew, en for English.
    Multiple languages are supported with the WPML or Polylang plugin.
    https://wpml.org/he/purchase
    https://wordpress.org/plugins/polylang

    Admin Email
    Email address for receiving notifications and logs from the plugin if a problem occurs.
    For other WooCommerce issues, the developer should enable debugging for WooCommerce itself. See:
    https://docs.woocommerce.com/document/woocommerce-product-search/api/debugging/

    PCI certification (highly important – always set to NO)
    Determines whether credit-card details can be entered directly on the checkout page.
    Important: This feature is not PCI-compliant, meaning it is not secure and exposes the payment page to malicious code injection that could steal credit-card details.
    When enabled, the Secure Transaction (3D Secure) module cannot be used.
    We recommend using UseIframe=yes and customizing the payment page.

    UseIframe
    Determines whether to run the module inside an IFRAME.
    According to credit-card-company requirements, the website must have an SSL certificate and use HTTPS.
    We recommend using UseIframe=yes and customizing the page using Low-Profile – Version 5 – Custom CSS/HTML.


    Accounting document settings:

    Invoice VAT Free
    The invoice will be issued with 0% VAT.
    Suitable for customers who sell abroad.

    Invoice Will Include VAT
    (Default) – the price and invoice include VAT.
    The system extracts the VAT amount on the invoice.
    For an exempt dealer, the appropriate document will be issued according to the Cardcom settings.

    Invoice Include Tax Per Product
    VAT at the product level, allowing products with and without VAT to be combined in the same order.

    Invoice Include VAT by Country
    VAT according to the shipping country in the order:
    Israel – includes VAT
    Any other country – excludes VAT
    We also recommend using this setting based on the customer's IP address; this requires adjustments to the page language and terminal settings.


    Order Status
    Updates the order status after successful payment.
    processing  | completed | on-hold
     

    Failed URL (3.5.1.0)
    In the current version, the plugin does not contain a failure URL field.
    The URL will be WooCommerce's default URL.
    To change it, edit the PHP code manually.
    Version updates may overwrite these changes.

    Success URL (3.5.1.0)
    In the current version, the plugin does not contain a success URL field.
    The URL will be WooCommerce's default URL.
    To change it, edit the PHP code manually.
    Version updates may overwrite these changes.

    Invoice for PayPal
    (Optional) Determines whether to issue an invoice for PayPal payments made through an external button, not located in the payment form.

    Invoice for PayPal – Send to Email
    Determines whether PayPal invoices should be sent by email.

    Debug Logging
    Enables or disables log writing.
    It is recommended to leave this disabled by default.
    It is intended only for analyzing plugin activity in the event of a problem.

    ID Number Field (ID/company registration number)
    Displays the invoice owner's ID number at checkout for document issuance in the system. This was added because of the requirement for allocation numbers.
    [Hidden | Optional | Required field]


    Creating invoices for PayPal – external button

    • The system issues an invoice for every PayPal transaction when its status changes to Completed or Processing, in addition to the PayPal event that reports completion of the transaction.

    • Using an internal button is recommended because the accounting document is sent immediately after the PayPal transaction is completed.

    • When using an external button, change the setting:
      Invoice for PayPal → select YES.


    Internal PayPal button option (displayed on the payment page)

    • Displays a PayPal button directly on the payment page.

    • Advantage: the invoice is sent immediately after the transaction is completed.

    Configuring a PayPal button on the payment page.


    If there is a problem with notifications or completing the order on the website

    For example: The remote server returned an error: (400) Bad Request

    The business should contact its hosting company and request that the following address ranges be opened in the company's firewall, including Cloudflare if applicable:

    • 82.80.227.17/255.255.255.248 (CIDR 29)

    • 82.80.222.124/255.255.255.248 (CIDR 29)

    The complete address range can be calculated using a CIDR calculator.

    If the server response contains:

    Response description from the server:

    -1
    <!-- Cached by ezCache -->
    <!-- Cache created i

    CallIndicatorResponse

    Disable the cache plugin on the WooCommerce website, as it is causing the problem.

    WordPress websites must receive a server response of 1- for the request to be valid.


     


     

    If a customer receives the following error message:

    “We are sorry, but there is a temporary problem processing the payment. Please try again in a few minutes or contact the store for assistance” – the business can ask the customer to try again in a few minutes. This is a temporary communication issue. You may also contact us to verify the issue.

     

    For unknown issues: enable Debugging for WooCommerce itself. This writes details of every order and its status to the log:
    https://woo.com/document/woocommerce-product-search/api/debugging

    When a customer enters a company name in checkout, that parameter is used on the invoice instead of the customer's first name, and only the company name appears on the payment page.


    For customers who want to use Checkout Blocks:

    Return to the classic display by selecting “Switch to classic checkout”.

    In WooCommerce, go to Pages → Checkout → Edit.

    How to switch back to WooCommerce Classic Checkout (0:35)
    https://youtu.be/bnkCkzCkY94?si=UypSKZ_z9iUpwzJl

    Or:

    (3:32) How to convert blocks checkout to classic checkout or default WooCommerce checkout
    https://youtu.be/1saN_yZ7-c8?si=WANYGQCTWpnl0KUN

    If the visual settings cannot be accessed, use this guide to return to the classic display:
    https://wordpress.org/support/topic/use-classic-woocommerce-checkout-but-still-use-blocks-otherwise/

    After clicking Switch to classic display, click Update at the top. Do not accidentally click the option to return to Blocks.


    To perform tests

    See the guide for performing tests.

    We recommend making a 1-shekel purchase with a credit card on the live terminal, not in test mode, to verify that the terminal is working properly and complete the entire purchase process.
    To customize the payment page, see this guide: Low-Profile: Custom Payment Page Design (Version 5) CSS/HTML.

    Was this article helpful?