Getting started with ePay
ePay offers a payment window that makes it easy to receive online payments - even if you don't have any technical or programming know-how. The payment window supports all the payment methods available through ePay and is regularly updated as new payment methods emerge.
You need to set up 1-4 new pages in your webshop to use ePay's payment window.
- A page that opens the payment window.
- (Optional) A page which your customers are directed to when the payment is completed (accepturl).
- (Optional) A page that your customers are directed to if they cancel the payment (cancelurl).
- (Optional) A page that ePay calls directly and instantly when the payment is approved (callbackurl).
Before you start
Before setting up the payment window on your webshop, you have to create a free test account with ePay. Once you've created the account, you'll receive a test merchant number which is used for making test payments.
Create your test account here. An ePay test account is free, and there are no strings attached whatsoever.
1. Open the payment window
The payment window can open in four different ways:
- Overlay - the payment window opens "on top" of your website (windowstate = 1)
- Iframe - looks like overlay, but integrated into your own website (windowstate = 2)
- Full screen (windowstate = 3)
- Mobile devices (force through the mobile payment window by setting mobile = 2. By default, it will auto-detect the used device)
- Integrated - a simple version integrated into your website (windowstate = 4). You set up the entire frame. Please note that you can only accept payment cards when using the integrated version (i.e. paymentcollection = 1).
When the customers have completed the payment, a receipt is shown in the payment window. If an accepturl is specified, the receipt will contain a continue button. When the customer clicks on this button, the payment window will close and the customer will be sent to the specified accepturl. Typically this will be a "Thanks for your order" page defined in your webshop.
GET parameters containing information about the transaction are appended. The parameters are described here.
If you want to skip the receipt in the payment window, the parameter ownreceipt must be set at the value 1. The customer will be sent directly to the accepturl when the payment is completed.
The customer is sent to the cancelurl if the payment window is closed before the payment is completed. Usually, this will be the page where the customer chooses how to pay. You set this URL in the parameter cancelurl.
This parameter is only used when the payment window is opened in full screen (windowstate set to 3) or for mobile payments.
The callbackurl is called instantly from the ePay server when the payment is completed. This is often used as a payment notification to update the order system, send an order confirmation by email etc.
5. Own parameters
Individual parameters can be passed through the payment window and back at accepturl, callbackurl, and cancelurl by appending the desired parameters as GET.