The following API documentation is provided to support system integrators undertake development to hook PaperCut in with other systems. Reasons for considering integration include:

• Real-time integration with other accounting and/or payment systems.
• Replace the balance in the PaperCut database with a value hosted in another system.
• Allow users to transfer funds from one system to another.
• Integration with stored value cards or campus "one card" solutions.
• Integration with commercial payment POS systems already in place in the organization.

These integration options are possible using one of three options:

Important: Always review the list of standard public APIs for your first development option rather than these advanced options below.

Option 1 - Outbound External Account XML-RPC Web Service API

The API set allow 3rd party system integrates to develop interfaces to instruct PaperCut to use an external source for account balances (i.e. replace the balance in the PaperCut database with a value hosted in another system in real-time). These documents cover the Outbound API set and should be read in conjunction with the standard Inbound Web Services APIs discussed in detail in the PaperCut Public API documentation.

IMPORTANT: Before starting you should discuss your options with the PaperCut development team.

Outbound APIs are a complex topic! The PaperCut Software Development Team is happy to answer any questions and/or work with system integrates to find the best solutions.

Option 2 - Inbound XML-RPC Web Service API

An alternate and simpler option to the External Account XML-RPC interface is to use the in-bound API and allow users to "push" funds (i.e. transfer) into their PaperCut account. See the Inbound API documentation and the

call for more details.

Option 3 - Payment Gateway

A third option may be to have your service added as an official credit source in the PaperCut Payment Gateway, allowing end-users to "pull" funds out of the external source direct from their PaperCut login account screen.

Categories: API