PaperCut Payment Gateway Module

This document discusses PaperCut Payment Gateway Module general configuration and use. This document should be read in conjunction with the Quick Start Guide written specifically for your preferred gateway type. The PaperCut Payment Gateway Module is an additional component that provides services to allow users to transfer funds from an external source into their personal PaperCut account. Examples of its use include: Online Payment Larger organizations such as universities or colleges may wish to provide online payment via 3rd party services provided by banks or organizations like PayPal. The payment interface may be provided for internal use (e.g. for student-only use), or opened up for external access to allow parents to make payments via the web. The Payment Gateway Module can hook into a number of leading service providers or may be quickly adapted to fit others. Student Fee/Management Systems A number of leading higher education organizations use the Payment Gateway Module to allow students to transfer small amounts of credit into their print account. At the end of semester/term, this amount is totalled up and added to their fees/loan. The Payment Gateway Module can be configured to automatically debit the student management records or an external database system. Cashless Systems Organizations that use a centralized point-of-sale system to manage cashless payment on campus can benefit from the PaperCut Payment Gateway. These systems provide a database of users and interfaces/APIs to withdraw funds from a centralized database. The Payment Gateway Module can be configured to use these APIs to transfer/withdraw funds from the central database. Custom Applications The Payment Gateway Module supports plug-ins and can quickly be customized to support other 3rd party systems. The customization can be performed by either the PaperCut development team or internally using your own development staff/skills. Contact PaperCut Software for development options and/or API documentation.

PaperCut - Payment Gateway Module

Installation
The Payment Gateway Module is licensed separately. First contact PaperCut Software or your supplier for licensing options. The licensing costs may vary depending on the type of interface as some external systems charge for external API access. 1. Ensure that you are running PaperCut version 9.6 or newer. 2. Download the latest Payment Gateway Module from: Windows: http://www.papercut.com/anonftp/pub/pcng/ext/paymentgateway/pcng-payment-gateway-module.exe Mac, Linux, Novel OES: http://www.papercut.com/anonftp/pub/pcng/ext/payment-gateway/pcngpayment-gateway-module.tar.gz Note: if you are running PaperCut 8.x a different installer is required. Please download the latest 8.x release instead from: http://www.papercut.com/anonftp/pub/pcng/ext/payment-gateway/pcngpayment-gateway-module-8.x.exe 3. Windows: Run and complete the installer, following the prompts. Other platforms: extract the contents of the archive to [apppath]/server/lib-ext/ 4. Open the configuration file located at [app-path]/server/libext/ext-payment-gateway.properties with a text editor such as WordPad.

Copyright 2008-2009 PaperCut Software International Pty. Ltd., All Rights Reserved.

2 of 5

PaperCut - Payment Gateway Module 5. Modify any of the settings as required (see below for description). 6. Each external credit source will require further configuration; sometimes at the PaperCut end via a config file (e.g. ext-payment-gatewayyourgateway.properties) and sometimes at the external source end. Follow the Quick Start Guide provided when your module was licensed.

Global Configuration Options The following configuration options are set in the ext-paymentgateway.properties file, and apply to all payment gateway modules. no-access-message This is the message that is displayed to the user when access is denied due to group settings defined in allowed-groups. Explaining why the user is unable to access the feature is advised. For example, Only full-time students have access to this feature. Normally however group based access control will remove the Add Credit link and hence will never see this message as they cant easily gain access to the page. user-error-message This defines a message displayed to the user when an error occurs. It may be useful to provide information on who to contact if the problem persists. Common Configuration Options The following configuration options are available on most gateway types/sources, and are edited via the config file for the specific gateway type (e.g. ext-paymentgateway-yourgateway.properties). module.page-title This setting allows changing the name of the link that appears in the left navigation menu of the end-user web tools. The default link is titled Add Credit. module.page-heading This setting allows changing the heading of the Add Credit page. The default heading is Add credit using Credit Card. module.allowed-groups It may be appropriate to restrict access to the modules services to a selected group of individuals in the organization. An example would be limiting access to full-time students only (members of the Full Time Students group). Group names correspond to groups from the directory (e.g. Active Directory or LDAP) that have been imported into PaperCut. module.allowed-amounts This setting controls the amounts youd like allow users to transfer. The fixed list ensures that users are unable to accidentally transfer too much in the one operation.

Copyright 2008-2009 PaperCut Software International Pty. Ltd., All Rights Reserved.

3 of 5

PaperCut - Payment Gateway Module Using the Payment Gateway An end-user will use the Payment Gateway Module using the following procedure. 1. Log into the PaperCut End-User web interface via http://server:9191/user or via the Details... link on the client. 2. Click on the Add Credit link. 3. Select the amount to add to your account. 4. Press the Add Value or Continue button. 5. Some gateway sources will apply the value immediately, while others such as Credit Card payment gateways will require further step such as card number entry and validation. Follow the steps on the screen as appropriate.

Transaction records All transfers to a users account will be recorded in the users transaction log. This log of activity may be useful for resolving problems or auditing transactions.

Copyright 2008-2009 PaperCut Software International Pty. Ltd., All Rights Reserved.

4 of 5

PaperCut - Payment Gateway Module External Access On a standard network the end-user web interface is only accessible to internal computers. It may be appropriate to open up the interface to external access to allow users to add credit from home, or to allow the parents of students to log in and use their credit card. External access can be enabled by opening up port 9191 or 9192 (the SSL port) on the organizations firewall. For example: [external address]:9192 [internal server]:9192

Some other gateway types may require additional ports. See the gateway specific documentation supplied.

Gateway Types
The Payment Gateway Module supports a number of external sources out of the box and others can be quickly added. Please contact the PaperCut Software development team for further information and documentation about integration with your preferred credit source.

Further Assistance
Please feel free to contact the PaperCut Software Development Team at support@papercut.com if you require assistance.

Copyright 2008-2009 PaperCut Software International Pty. Ltd., All Rights Reserved.

5 of 5