Please wait ...


Loading...

Configuration in osCommerce

1. Information on the payment in osCommerce

Find payment details in the osCommerce administration through the menu Customers -> Orders. Your order and transaction numbers are available in the column Comments (please see image 1). 

The order and transaction numbers in osCommerce match the numbers in ePay’s administration.

2. Settings

The settings are found in the menu Modules -> Payment. Click on the ePay module, and press ‘Edit’ on the right.


Enabled

Put this setting at Enabled to activate ePay as a payment method in your osCommerce shop.

Sort order of display

This determines the order in which your payment methods are displayed. If you put the value at 1, ePay is displayed first.

New order status (when the payment is made)

Choose the status orders are given after payment. This is used to distinguish between paid and non-paid orders.

Payment zone

Choose from which countries this payment method is available. 

Merchant number

The merchant number you received from ePay. You’ll find it in the menu Settings -> Payment system in the ePay administration.

Instant capture

If you activate instant capture, payments are captured instantly. You can only use this if you customers receive their products immediately, e.g. downloads or services.

Group

In the ePay administration you can divide your payments into different groups. Moreover, you can limit the access of your ePay users to specific groups. A group is simply a name/string. Please leave the field empty (default) if you do not want to use groups.

MD5 key

If you’ve activated MD5 in ePay, enter your secret key here (your key is the password you’ve entered in the ePay administration). It’s very important that the keys are identical in the two systems.

Process payments from within the order administration of osCommerce (Remote API)

To process payments from osCommerce, activate this setting. This enables you to capture, delete, and credit payments from the order view in osCommerce.

Remote API password

If you’ve entered a password in the ePay administration under API/Web service -> Access, you have to enter the same password here.

Auth Mail

To receive an email at every completed payment, enter an email address here. If you have multiple recipients, you can separate the addresses with a semicolon (;). Leave the field empty if you don’t want to use this service.

Window state

”Window state” lets you define how the payment window is displayed. You can choose between overlay (a window which opens on top of your website) or full screen. We recommend overlay so your website is visible behind the payment window.

Add payment fee to the "order and invoice"

By activating this, a line containing the transaction fee is added to the customer’s order confirmation and invoice. Please note that Transaction fee in Modules -> Order Total must be activated.


The above functions are built into the payment module for osCommerce, but you can implement all the functions we offer by adding the relevant parameters. For a full list of the available parameters, please click here.

3. Change language

You can change or add a language to the ePay module.

To change a language:

Go to the folder \includes\languages\english\modules\payment

Open the file epaywindow.php, and make the desired changes. Please note that you can only edit the text in the right column (the highlighted area in image 2). If you edit the text in the left column, your translation will malfunction.

To add a new language:

Copy the file epaywindow.php to a different folder, e.g. \includes\languages\german\modules\payment

Open the file \includes\languages\german\modules\payment\epaywindow.php. In image 2 below you can see how it looks. Here you’ll find the labels which define the language in the payment module. Make your changes to the text on the right. 

If you’d prefer Danish in the osCommerce administration, please install this language pack:
http://www.oscommerce.com/community/contributions,5684/category,7/

4. Process payments from osCommerce

You can process your payments from the order view in osCommerce. This means you no longer have to log in to your ePay administration to capture, credit, or delete payments.

To do this, put the setting "Process payments from within the order administration of osCommerce" at Enabled.

Go to your ePay administration, and find API/Web service in the menu on the left. Please note that the IP address of the osCommerce installation must be registered in API/Web service -> Access

The following payment details are available in osCommerce:

  • Transaction status
  • Order number
  • Acquirer
  • Currency code
  • Split payment status
  • 3D Secure status
  • Description (if any)
  • Cardholder’s name (if any)
  • Authorised amount and time stamp
  • Captured amount and time stamp
  • Credited amount and time stamp
  • Transaction fee (if any)

To capture a payment, find the order and press ‘handle payment’, right by the card number. Enter the amount you want to capture, and press the ‘Capture’ button (please see image 3).

To cancel an order and delete the payment, press ‘Delete’.

To credit a payment, enter the amount to be refunded, and press ‘Credit’.

5. Change existing osCommerce files

When installing ePay’s module, certain osCommerce files are overwritten. If you’ve made any changes to these files, you should merge them with the files from the ePay module.

ePay’s module overwrites the files below:

/account_history_info.php
/checkout_process.php
/admin/orders.php
/admin/invoice.php
/admin/packingslip.php
/admin/includes/languages/danish/orders.php
/admin/includes/languages/english/orders.php
/includes/classes/order.php

Amendments from ePay to the files above are indicated by:

// ———— ePay added start ———
and
// ———— ePay added end ———

6. Upgrade to the new payment window

Notice: Only for osCommerce version 2.3.
Uninstall the old ePay module (version 2.2 and earlier).

Install the new module

Find the following files one by one:

/account_history_info.php
/checkout_process.php
/admin/orders.php
/admin/invoice.php
/admin/packingslip.php
/admin/includes/languages/danish/orders.php
/admin/includes/languages/english/orders.php
/includes/classes/order.php

Remove all code between the following comments:

// ———— ePay added start ——— 
and
// ———— ePay added end ———