icepay oscommerce 2 module...icepay oscommerce 2 module – manual for merchants / developers 6.4...

ICEPAY osCommerce 2 Module Manual for merchants / developers

---

10/24/2011

1

ICEPAY osCommerce 2 Module – Manual for merchants / developers

Contents

Information ............................................................................................................................ 2

1.1 Overview ................................................................................................................. 2

1.2 Releases ................................................................................................................. 2

1.3 Compatibility............................................................................................................ 2

1.4 Requirements .......................................................................................................... 2

2 Installation ...................................................................................................................... 3

2.1 Manual installation................................................................................................... 3

3 Upgrade ......................................................................................................................... 5

3.1 Module .................................................................................................................... 5

4 Uninstall ......................................................................................................................... 6

4.1 Module .................................................................................................................... 6

5 Configuration .................................................................................................................. 7

5.1 First use .................................................................................................................. 7

6 Settings information ........................................................................................................ 8

6.1 Core module............................................................................................................ 8

6.2 ICEPAY Credit card module .................................................................................... 9

6.3 ICEPAY Direct Debit module ..................................................................................10

6.4 ICEPAY Direct E-Banking (Sofort banking) module ................................................11

6.5 ICEPAY giropay module .........................................................................................12

6.6 ICEPAY iDEAL module ..........................................................................................13

6.7 ICEPAY PayPal module .........................................................................................14

6.8 ICEPAY paysafecard module .................................................................................15

6.9 ICEPAY Phone PBAR module ...............................................................................16

6.10 ICEPAY SMS module .............................................................................................17

6.11 ICEPAY Wallie Card module ..................................................................................18

6.12 ICEPAY Wire Transfer module ...............................................................................19

7 License conditions .........................................................................................................20

2


Information Manual version: 0.1

Author: Olaf Abbenhuis

Copyright: ICEPAY B.V.

1.1 Overview

This module enables the use of ICEPAY payment methods in your osCommerce 2 webshop.

Module webpage:

http://www.icepay.com/webshop-modules/online-payments-for-oscommerce

1.2 Releases

The list of releases is available online:


1.3 Compatibility

The compatibility chart is available online:


1.4 Requirements

You need the following requirements to be able to use the module:

Software

osCommerce See Compatibility

PHP 5+




3


2 Installation

2.1 Manual installation

Step 1. Download and unzip

Download the module and unzip it to a folder on your computer.

Step 2. Upload

Upload the files as followed:

Module folder Copy to

/catalog/ext /ext

/catalog/images /images

/catalog/includes /includes

Step 3. Server directory writing privileges

Ensure the following folder is writable:

Folder Required for

/catalog/includes/modules/payment/icepay/icepay_log Storing daily transaction log files

Step 4. Install the module within osCommerce

Log in to your administrator backend:

Browse to Action

Modules -> Payment Install Module

4


Install at least the following module:

Module Description

ICEPAY – Core module This enables all other ICEPAY modules

Install at least one of the following modules. More than one is optional:

Module Description

ICEPAY – Pay with Creditcard Enable and configure for creditcard payments

ICEPAY – Pay by Direct Debit Enable and configure for DirectDebit payments

ICEPAY – Payment by Direct E-Banking* Enable and configure for Direct E-Banking* payments

ICEPAY – Payment by giropay Enable and configure for giropay payments

ICEPAY – Payment with iDEAL Enable and configure for iDEAL payments

ICEPAY – Pay by PayPal Enable and configure for PayPal payments

ICEPAY – Payment with paysafecard Enable and configure for paysafecard payments

ICEPAY – Payment with Phone call Enable and configure for Phone Progress bar payments

ICEPAY – Payment with SMS Enable and configure for SMS text payments

ICEPAY – Payment with Wallie-card** Enable and configure for Wallie payments

ICEPAY – Payment with Wire Transfer Enable and configure for Wire Transfer payments

* Direct-Ebanking is the same payment method as sofortbanking.

** Please note that Wallie cards are no longer for sale, because Wallie is now paysafecard. The Wallie

cards can only be used until January 31th 2012, more information at the paysafecard website.

ICEPAY offers Wallie as a payment option until January 31th 2012, afterwards you can use the

paysafecard option.

The module is now installed and ready for configuration.

Read configuration for more information.

http://www.paysafecard.com/uk/promotions/wallie-wird-paysafecard/

5


3 Upgrade

3.1 Module

It is recommended to always use the latest version of the module.

To upgrade the module, follow step 1 to 3 mentioned in the Installation chapter. The

configuration is stored within the database and will not be overwritten.

Check all configuration settings of the module after an installation. It is possible some

settings have changed or were added.

6


4 Uninstall

4.1 Module

To uninstall the module, log in to your administrator backend:

Browse to Action

Modules -> Payment -> ICEPAY Remove Module

7


5 Configuration

5.1 First use

Step 1. Open the configuration section

To configure the module, log in to your administrator backend:

Browse to Action

Modules -> Payment -> Online Payment with ICEPAY Edit

Step 2. Link an ICEPAY merchant website

Use the generated Merchant URLs to create a new Merchant website in your ICEPAY

account.

To view the 3 generated URLs, go back to the ICEPAY payment module before editing the

configuration.

Once you have created a merchant with these URLs you will receive a Merchant ID and

Secret Code. Edit the module and copy-paste these into the proper sections.

More information about creating an ICEPAY merchant can be found here:

https://www.icepay.com/how-to-test

Step 3. The core module

Enabling the core module (‘Online Payment with ICEPAY’) will display ICEPAY as a payment

method within the webshop checkout. Disabling the core module and enabling an ICEPAY

payment method (such as iDeal) will allow individual payment methods to be used.

Note that the merchant must at least be linked to one ICEPAY module, in order to use any of

the ICEPAY modules.

Read the settings section for more information.

https://www.icepay.com/how-to-test

8


6 Settings information

6.1 Core module

Browse to Action

Modules -> Payment -> Online Payment with ICEPAY Edit

Settings

Options Description Recommended setting

Enable ICEPAY Module Enable or disable the module

Merchant ID Required to link a merchant (Read: Configuration, First use)

Secret Code Required to link a merchant (Read: Configuration, First use)

Set Order Status Preparing

The order status when an order is created but no payment information available yet

Pending

Set Order Status Successful

The order status when the payment has been received completely

Success [ICEPAY]

Set Order Status Cancelled

The order status when an error occurred or the customer cancelled the transaction

Cancelled [ICEPAY]

Set Order Status Refund

The order status when a refund has been processed

Refund [ICEPAY]

Set Order Status Chargeback

The order status when a chargeback has been requested

Chargeback [ICEPAY]

Set Order Status Open

The order status when the ICEPAY transaction has been started but no payment information available yet

Pending

Sort Order of display Order of payment methods in checkout

1

Send confirmation e-mail after successful payment

Send an order e-mail once the full amount has been paid

True

Send confirmation e-mail after order has been placed

Send an order e-mail before transaction data is known

True

Language display settings Link a language to the transaction, this has an effect on which payment methods will be shown

DETECT

Currency Link a currency to the transaction, DETECT

9


this has an effect on which payment methods will be shown

Country Link a (billing) country to the transaction, this has an effect on which payment methods will be shown

DETECT

Update stock only on success Stock will be normally subtracted, once an order has been created. This happens before payment information is available. The feature only removes from stock if a payment has been successful.

True

Display icons Display payment method images in checkout

True

Enable log to files Generate log files with transaction data. Ensure the folder is writable (Installation)

True

6.2 ICEPAY Credit card module

Browse to Action

Modules -> Payment -> Payment with Creditcard Edit

Settings


Enable Enable or disable the module

Sort order of display Order of the payment method in checkout


DETECT

Currency Link a currency to the transaction, this has an effect on which payment methods will be shown

DETECT

Payment Zone Enable this payment method for a specific payment zone

10


6.3 ICEPAY Direct Debit module

Browse to Action

Modules -> Payment -> Pay by Direct Debit Edit

Settings





DETECT


Nothing to change

Country Link a country to the transaction, this has an effect on which payment methods will be shown

Nothing to change


11


6.4 ICEPAY Direct E-Banking module

Browse to Action

Modules -> Payment -> Payment by Direct E-Banking* Edit

* Direct-Ebanking is the same payment method as sofortbanking.

Settings





DETECT


DETECT


USER


12


6.5 ICEPAY giropay module

Browse to Action

Modules -> Payment -> Payment by giropay Edit

Settings





Nothing to change


Nothing to change


Nothing to change


13


6.6 ICEPAY iDEAL module

Browse to Action

Modules -> Payment -> Payment with iDEAL Edit

Settings




Query bank information Query available banks from ICEPAY server

True


14


6.7 ICEPAY PayPal module

Browse to Action

Modules -> Payment -> Pay by PayPal Edit

Settings





DETECT


00


15


6.8 ICEPAY paysafecard module

Browse to Action

Modules -> Payment -> Payment with paysafecard Edit

Settings





DETECT


16


6.9 ICEPAY Phone PBAR module

Browse to Action

Modules -> Payment -> Payment with Phone Call Edit

Settings





DETECT


DETECT


DETECT


17


6.10 ICEPAY SMS module

Browse to Action

Modules -> Payment -> Payment with SMS Edit

Settings





DETECT


DETECT


DETECT


18


6.11 ICEPAY Wallie Card module

Browse to Action

Modules -> Payment -> Payment with Wallie-card* Edit

* Please note that Wallie cards are no longer for sale, because Wallie is now paysafecard. The Wallie

cards can only be used until January 31th 2012, more information at the paysafecard website.

ICEPAY offers Wallie as a payment option until January 31th 2012, afterwards you can use the

paysafecard option.

Settings





DETECT


DETECT


Nothing to change


http://www.paysafecard.com/uk/promotions/wallie-wird-paysafecard/

19


6.12 ICEPAY Wire Transfer module

Browse to Action

Modules -> Payment -> Pay by Wire Transfer Edit

Settings





DETECT


DETECT


Nothing to change


20


7 License conditions

Definitions

ICEPAY payment module

The software product provided by ICEPAY B.V. on an ‘as is’ basis without any warranty of any kind.

License

A written public act of the Dutch central bank or other governmental body which provides ICEPAY B.V. with these rights.

User license conditions webshop module

This User License Agreement applies to the use of this ICEPAY webshop module, as

supplied by ICEPAY B.V. (further referred to as ICEPAY B.V.).

BY USING ICEPAY WEBSHOP MODULE YOU FULLY AGREE TO THE CONDITIONS OF

THIS USER LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THIS LICENSE

AGREEMENT, YOU SHOULD REFRAIN FROM USING THE ICEPAY WEBSHOP

MODULE.

You may only use the ICEPAY webshop module if such is directly obtained from ICEPAY

B.V. and downloaded from www.icepay.com and if you or the organization where you work

has entered into an official contract with ICEPAY B.V. and therefore is a Customer in

accordance with these conditions.

This User License Agreement and the use of the ICEPAY webshop module are governed by

the laws of The Netherlands. Any disagreement will be placed before a qualified court in The

Hague, The Netherlands. The United Nations Convention on Contracts for the International

Sale of Goods (CISG) is not applicable.

User license ICEPAY webshop module

ICEPAY B.V. grants Customer the non-exclusive right to use this ICEPAY webshop module

and corresponding documentation. The license shall go into effect after Customer has

fulfilled all its obligations.

The license is limited exclusively to own use of the ICEPAY webshop module for the agreed

upon Central Processing Unit (CPU), number of users, servers, websites, 0900 numbers,

and/or workstations. If no limitations have been agreed upon, the license will be limited to the

CPU on which the ICEPAY webshop module was first installed and the number of users,

servers, websites, 0900 numbers, and/or workstations will be limited to 1 (one). Customer is

21


allowed to make one back-up copy of the ICEPAY webshop module for safety purposes only,

if a back-up is not provided for by ICEPAY B.V.

This license for this ICEPAY webshop module is limited to the object code. Rights to the

source code are not provided, unless explicitly agreed upon otherwise in writing. The license

with regard to this ICEPAY webshop module for which ICEPAY B.V. has a License is limited

to use within the framework of the applicable License.

It is prohibited for Customer directly or indirectly (through a third party) to copy or duplicate

the ICEPAY webshop module in any way, without the prior written approval from ICEPAY

B.V. The license to use the ICEPAY webshop module cannot be transferred to any third

party (third parties also include holding, affiliated, and/or subsidiary companies). Customer

does not have the right to make the ICEPAY webshop module available, under any title or in

any way whatsoever, to any third party (third parties also include holding, affiliated, and/or

subsidiary companies).

Customer is authorized to alter (in the source code) the ICEPAY webshop module. Any

alterations are the sole responsibility and risk of Customer. All work performed by ICEPAY

B.V. related to a support question on an ICEPAY webshop module whose code has been

changed (to some extent, however small) shall be charged to Customer on the basis of

actual costs in accordance with the standard rates of ICEPAY B.V.

Warranty disclaimer

The ICEPAY webshop module is made available on an “as is” basis only and without any

warranty or indemnity of any kind.

ICEPAY B.V. makes no warranties, conditions, indemnities, representations or terms,

express or implied, whether by statute, custom, or otherwise as to any other matters,

including but not limited to non-infringement of third party rights, integration, accuracy,

security, availability, satisfactory quality, merchantability or fitness for any particular purpose.

Limitations to indemnification & liability

Customer agrees to indemnify ICEPAY B.V. from all liability, losses, actions, damages or

claims (including all reasonable costs and attorney costs) which flow forth or are regarding

the use or dependency upon the ICEPAY webshop module.

Under no circumstances will ICEPAY B.V. be liable to Customer, or any other person or

entity, for any loss of use, revenue or profit, lost or damaged data, or other commercial or

economic loss or for any direct, indirect, special, statutory, or consequential damages

whatsoever related to the use or reliance upon ICEPAY webshop module, even if advised of

the possibility of such damages or if such damages are foreseeable. This limitation shall

apply to each breach of this User License Agreement by ICEPAY B.V.

22


Additional work & support

All activities that ICEPAY B.V. must perform upon request of Customer related to the use of

the ICEPAY webshop module, which has been made available at no charge, shall be

invoiced as additional work (or support) on the basis of actual costs according to the

applicable rates of ICEPAY B.V.

(Future) incompatibility problems (products are unable to interoperate with each other) can

be resolved on the basis of additional work.

It will be assumed that Customer has agreed with the performance of additional work and the

connected costs, if Customer has allowed additional work to take place without raising

objections in writing prior to the commencement of additional work.

Installation and implementation

ICEPAY B.V. will only install and/or implement the ICEPAY webshop module or have it

installed and/or implemented if agreed upon in writing.

Prior to installation and/or implementation Customer will see to it, at its own expense, that all

conditions required by ICEPAY B.V. have been met in order to ensure a successful

installation and/or implementation.

Customer will ensure and is entirely responsible for fulfilling the conditions of the necessary

software licenses in order to let installation and/or implementation take place legally.

Duration

This agreement is effective as of the moment of acceptance and may be terminated at any

time by ICEPAY B.V. whereby a notice period of one week shall apply.

General conditions/applicability

The General Conditions ICEPAY apply to the agreement. The applicability of purchase

conditions or any other conditions from Customer or third parties is, then, expressly rejected

by ICEPAY B.V. Customer explicitly declares to have received the General Conditions

ICEPAY and to agree with the General Conditions ICEPAY.

icepay oscommerce 2 module...icepay oscommerce 2 module – manual for merchants / developers 6.4...

Documents