modules/quickpay/README.txt

$Id: README.txt,v 1.2 2009/03/07 19:46:02 xen Exp $

OVERVIEW
======== 

This module works with the Danish payment gateway provider QuickPay.dk
allowing you to receive payments using the payment options supported
by QuickPay on your Drupal site.

It includes 2 sub modules to implement the gateway into a shop based
on either the ECommerce package or the Ubercart package.

Development of these modules has been sponsored by QuickPay themselves.

=== WARNING ===

While these modules are as plug and play as is possible, setting up
online payment requires some insight into Drupal, payment gateways and
PBS requirements, and is not for the casual user. If in doubt, consult
a professional.

INSTALLATION
============

Unpack the module to sites/all/modules, and activate the Quickpay
module and either the ECommerce or Ubercart module at
admin/build/modules. Configure the modules at either
admin/ecsettings/quickpay or
admin/store/settings/payment/edit/methods, depending on what
e-commerce package you're using. The settings should be fairly strait
forward, but do read the IMPLEMENTATION section later in this
document, as it contains some important information.

Using quickpay.module in a custom Drupal solution
-------------------------------------------------

The core module can be used as a payment gateway in a custom written
(ie. not using ECommerce or Ubercart) Drupal solution. What is needed
is basically to present the quickpay_settings_form somewhere (using
system_settings_form), and then use the, as yet undocumented API. Take
a look at ec_quickpay and uc_quickpay for example code.

IMPLEMENTATION
==============

The core module provides a block to show the accepted credit cards, as
required by PBS. Note that it doesn't enforce payments to only use
those cards.

Remember that PBS requires that the customer gets an confirmation of
the order either by email or as a web page. To implement this as a web
page, ec_quickpay has configuration options to set the page that
customers will be redirected to on success, while Ubercart has its own
setting. As a convenience the modules sets $_SESSION['last_order'] to
the id of the last successful order in this session, which allows the
page to display an appropriate confirmation page.

AS YET UNSUPPORTED FEATURES
====================
* Autocapture
* Subscriptions, for both ECommerce and Ubercard (supported by core API)

AUTHOR / MAINTAINER
===================
Thomas Fini Hansen (aka Xen.dk on Drupal.org)
xen at xen dot dk
1	$Id: README.txt,v 1.2 2009/03/07 19:46:02 xen Exp $
2
3	OVERVIEW
4	========
5
6	This module works with the Danish payment gateway provider QuickPay.dk
7	allowing you to receive payments using the payment options supported
8	by QuickPay on your Drupal site.
9
10	It includes 2 sub modules to implement the gateway into a shop based
11	on either the ECommerce package or the Ubercart package.
12
13	Development of these modules has been sponsored by QuickPay themselves.
14
15	=== WARNING ===
16
17	While these modules are as plug and play as is possible, setting up
18	online payment requires some insight into Drupal, payment gateways and
19	PBS requirements, and is not for the casual user. If in doubt, consult
20	a professional.
21
22	INSTALLATION
23	============
24
25	Unpack the module to sites/all/modules, and activate the Quickpay
26	module and either the ECommerce or Ubercart module at
27	admin/build/modules. Configure the modules at either
28	admin/ecsettings/quickpay or
29	admin/store/settings/payment/edit/methods, depending on what
30	e-commerce package you're using. The settings should be fairly strait
31	forward, but do read the IMPLEMENTATION section later in this
32	document, as it contains some important information.
33
34	Using quickpay.module in a custom Drupal solution
35	-------------------------------------------------
36
37	The core module can be used as a payment gateway in a custom written
38	(ie. not using ECommerce or Ubercart) Drupal solution. What is needed
39	is basically to present the quickpay_settings_form somewhere (using
40	system_settings_form), and then use the, as yet undocumented API. Take
41	a look at ec_quickpay and uc_quickpay for example code.
42
43	IMPLEMENTATION
44	==============
45
46	The core module provides a block to show the accepted credit cards, as
47	required by PBS. Note that it doesn't enforce payments to only use
48	those cards.
49
50	Remember that PBS requires that the customer gets an confirmation of
51	the order either by email or as a web page. To implement this as a web
52	page, ec_quickpay has configuration options to set the page that
53	customers will be redirected to on success, while Ubercart has its own
54	setting. As a convenience the modules sets $_SESSION['last_order'] to
55	the id of the last successful order in this session, which allows the
56	page to display an appropriate confirmation page.
57
58	AS YET UNSUPPORTED FEATURES
59	====================
60	* Autocapture
61	* Subscriptions, for both ECommerce and Ubercard (supported by core API)
62
63	AUTHOR / MAINTAINER
64	===================
65	Thomas Fini Hansen (aka Xen.dk on Drupal.org)
66	xen at xen dot dk