With plugin
Use this guide if your webshop runs on a supported platform such as WooCommerce, Magento, Shopify, Shopware, PrestaShop or OpenCart.
A plugin is the fastest way to add ePay to an existing webshop. The plugin connects your webshop to ePay, creates payments and updates order statuses when payments are completed.
What you will do
In this guide, you will:
Install or open the ePay plugin
Add your API key
Add your Point of Sale ID
Configure your payment methods
Place a test order
Confirm that the order status updates correctly
Before you start
You need:
- Access to your webshop administration panel
- Access to ePay Backoffice
- An API key
- A Point of Sale ID
You can find your API key and Point of Sale ID in ePay Backoffice.
Step 1: Choose your platform
Start by choosing the plugin guide for your webshop platform.
WordPress webshop plugin
Composer-based Magento module
Hosted app for Shopify checkout
Module for PrestaShop stores
Plugin for Shopware 6
Extension for OpenCart 4
Each platform has its own installation steps, but the basic setup is the same.
Step 2: Install the plugin
Install the ePay plugin in your webshop.
Depending on your platform, you may install it from a marketplace, upload it manually or enable it from your webshop administration panel.
After installation, open the ePay plugin settings.
Step 3: Connect the plugin to ePay
Add your ePay test credentials to the plugin.
You usually need:
| Value | Description |
|---|---|
| API key | Used to connect your webshop to ePay |
| Point of Sale ID | Identifies the webshop or sales location |
Make sure you use test credentials while setting up and testing the plugin.
Step 4: Configure payment methods
Choose the payment methods you want to show in checkout.
The available payment methods depend on your ePay account, your payment agreements and your plugin setup.
Start with one payment method while testing. You can add more later.
Step 5: Place a test order
Go to your webshop and place an order like a normal customer.
At checkout, choose ePay as the payment method.
Complete the payment with a test card.
Step 6: Check the order status
After the payment, return to your webshop administration panel.
Check that the order status has changed correctly.
A successful test payment should usually move the order from pending payment to a paid or processing state, depending on your webshop platform and plugin settings.
Step 7: Test a failed payment
You should also test what happens when a payment fails.
A failed payment should not mark the order as paid.
Check that your webshop handles the failed payment in a way that makes sense for your customers.
Common problems
The payment method does not appear in checkout
Check that:
- The plugin is enabled
- The test environment is enabled
- Your API key is correct
- Your Point of Sale ID is correct
- The payment method is enabled in the plugin
- The payment method is available on your ePay account
The payment opens, but the order is not updated
Check that:
- Your webshop can receive payment notifications
- Your website is publicly available
- Your plugin settings are correct
- Your order status settings are configured correctly
The plugin says the API key is invalid
Check that:
- You copied the full API key
- You are using An API key in the test environment
- You are not using a live API key in the test environment
- There are no extra spaces before or after the key
What you built
You have now connected your webshop to ePay and created your first test payment.
Before going live, you should also test:
- Successful payments
- Failed payments
- Cancelled payments
- Order status updates
- Refunds, if supported by your plugin
- The full customer checkout experience