Skip to main content

ePay WooCommerce plugin

WooCommerce header

ePay WooCommerce Payment Module Documentation

The ePay payment module integrates seamlessly with WooCommerce—WordPress’s leading eCommerce extension—so you can start accepting card payments quickly. Whether you are just testing or ready for production, the module supports both test and live environments with a simple upgrade process.

Prerequisites​

  • ePay Account:
    Sign up for a free ePay account to receive a unique merchant number for testing.

  • WordPress & WooCommerce:
    Install WordPress and the WooCommerce plugin before installing the ePay module.

  • Backup Your Site:
    Before installing new plugins, always back up your website to prevent data loss.

Installation and Setup​

warning

Before installing the module, make a backup of your website.

Follow these steps:

  1. Download and Unzip:

  2. Upload to WordPress:

    • Upload the module folder to your WordPress installation directory:
      /wp-content/plugins/
    • This can be done via an FTP client.

  3. Activate the Plugin:

    • Log in to your WordPress admin area (e.g., http://yoururl/wp-admin).
    • Navigate to Plugins in the left menu.
    • Locate the ePay module and click Activate.

  4. Configure in WooCommerce:

    • In your WordPress admin, go to WooCommerce → Settings.
    • Click on the Payment Gateways tab and select EPay from the top overview.
    • Check the box labeled Enable ePay and click Save changes.
    • Enter the merchant number you received from ePay in the Merchant number field and click Save changes.

After these steps, your module is installed. It’s now time to test it!

Test the Payment Module​

Before going live, ensure your payment module works correctly:

  1. Domain Registration:

    • Register the domain from which you are testing in your ePay administration under Settings > Payment system.
    • An unregistered domain may prevent the payment window from opening for customers.

  2. Perform a Test Transaction:

    • Complete a purchase in your store.
    • Fill in your details, choose ePay as the payment method, and click Place Order.
    • The payment window will then open (an overlay version is used by default).

  3. Customize the Payment Window:

    • You can add your logo and company information to the payment window.
    • To customize, log into your ePay administration and navigate to Settings → Payment window.

Once the payment is completed, the customer is redirected to the WooCommerce order confirmation page, which you can edit from within WordPress.

Configuration in WooCommerce​

Module Settings​

Access the module settings in WooCommerce → Settings → Payment Gateways and click on EPay. Configure the following parameters:

SettingDescription
TitleThe name of the payment method as seen by customers at checkout (e.g., "Pay with Credit Card").
DescriptionA short description of the payment method that appears at checkout.
Merchant numberThe merchant number provided by ePay. You can also find it in your ePay administration under Settings → Payment system.
Window IDSelect the version of the payment window. Create different versions via Settings → Payment window in your ePay administration for varied texts, logos, or fee settings.
MD5 keyIf MD5 is activated in ePay, enter the same key used in your ePay administration to ensure secure transactions.
Instant captureEnable this option to capture the payment immediately, suitable for instant product delivery (e.g., digital downloads).
GroupOptionally divide your payments into groups. Leave empty if you are not using this feature.
Auth MailSpecify one or more email addresses (separated by semicolons) to receive a notification each time a payment is completed.
Own ReceiptEnable to redirect customers to your custom WooCommerce order confirmation page after payment completion.
Remote interfaceActivate this to capture, credit, or delete payments directly from WooCommerce without logging into the ePay administration.
Remote passwordEnter the password you set in your ePay administration under API/Webservices → Access.
Invoice dataEnable to send invoice data to the payment window, useful for invoice payments or sending receipts via Storebox.com/Kvittering.dk.
Add fee to orderEnable to display the transaction fee on the order page. Configure whether you or your customer covers the fee in your ePay administration under Settings → Payment window.

You can also manually define parameters in your module files if needed. See our technical documentation for a complete list of available parameters.

Subscription Payments​

ePay’s module supports recurring (subscription) payments out of the box. To enable subscriptions:

  1. Install WooCommerce Subscriptions:

    • Download and install the official WooCommerce Subscriptions plugin.

  2. Register Your IP Address:

    • In your ePay administration, go to API/Webservices → Access and register the IP address of your website.

Processing Payments from WooCommerce​

You can manage payments directly from your WooCommerce administration:

  1. Enable Remote Interface:

    • In the ePay module settings, ensure Remote interface is activated.

  2. Whitelist Your Server IP:

    • In your ePay administration under API/Webservices → Access, add the IP address of your WooCommerce installation.

  3. Payment Management:

    • When viewing an order in WooCommerce, you’ll see detailed payment information such as:
      • Transaction number
      • Order number
      • Currency
      • Authorized, captured, and credited amounts (with timestamps)
      • Description and cardholder’s name (if available)
      • Transaction fee (if applicable)
    • To capture a payment, click the order number in the orders menu and select Capture.
    • Once captured, a Credit button appears to process refunds (full or partial).

FAQ & Troubleshooting​

Common Questions​

How do I govern which payment window to use?​

Use the Window ID setting in the ePay module configuration to select the desired payment window. If issues occur, try removing and re-entering the value, then save your settings.

What should I do if I encounter conflicts with other plugins?​

Many issues are caused by conflicts with other plugins or custom themes. Try:

  • Updating to the latest version of the ePay module.
  • Switching to a default WooCommerce theme.
  • Deactivating other plugins one-by-one to isolate the conflict.
  • Contacting us with details about any specific plugin conflicts so we can work on compatibility improvements.

Error Messages and Solutions​

Error: "Call to undefined function message"​

This error can occur when:

  • The remote password in WooCommerce does not match the one in your ePay administration under API/Webservices → Access.
    Solution: Ensure both passwords are identical.

  • Your store’s IP address is not registered in the ePay administration.
    Solution: Register the IP address under API/Webservices → Access.

Error Code 403​

If you see error code 403, it might be due to conflicts with the iThemes Security plugin.
Solution:

  • Deactivate Hackrepair.com's blacklist feature under Banned users in the plugin settings.
  • Contact iThemes Security for further assistance.

For further assistance or to report any issues, please contact our support team.

Happy selling with ePay and WooCommerce!