Contents
How to set up the Payment Gateway Module
THE PAGE APPLIES TO:
Last updated September 30, 2025
Contents
Documentation
All documentation for the Individual Payment Gateways, and the ‘Payment Gateway Module - Manual’ which covers the general installation for the Payment Gateways, can be found on the Payment Gateway Guides page.
Step 1. Purchase an updated PaperCut license or subscription
If you’re a PaperCut NG customer, you can use the PaperCut NG Online Orders page in order to add a Payment Gateway component to your current license, or purchase a new license with the Payment Gateway component.
If you’re a PaperCut MF customer, you’ll need to contact your Authorized PaperCut Partner for a quote and an updated license file (or updated Subscription if you’re using PaperCut MF subscriptions).
Step 2. Download and install the Payment Gateway Module
Payment Gateway module downloads:
| Payment Gateway version | Windows link | macOS, Linux, or Novell link |
|---|---|---|
| 25.0.326 - compatible with NG/MF version 25 and later. | pcng-payment-gateway-module.exe | pcng-payment-gateway-module.tar.gz |
| 23.0.271 - compatible with NG/MF version 24 and earlier. | pcng-payment-gateway-module.exe | pcng-payment-gateway-module.tar.gz |
Step 3: Configure the specific Payment Gateway required
Download the configuration guides for your specific Payment Gateway (e.g. PayPal / Blackboard etc).
Payment Gateway Module Release History
| Date | Version | Note | Change ID |
|---|---|---|---|
| 12 Aug 2025 | 25.0.325 | Introduced a new version of the payment gateway module based on the new PaperCut NG/MF application server version 25.0 due to incompatibility issues. This version is only compatible with PaperCut NG/MF version 25 and later. |
[PO-3404] |
| 19 Jan 2024 | 23.0.271 | Fixed an issue with CBORD Payment Gateway where extraneous data was being prefixed to XML responses. [PO-1612] Security enhancement to ensure that all password fields within the configuration files; server.properties and any payment gateway configuration files, are encrypted. [PO-1130] |
[PO-1612][PO-1130] |
| 19 Jan 2023 | 22.0.248 | Fixed an error that showed an error page on devices when trying to top up an account on demand. Fixed an error in the Official payment gateway. Fixed an error that canceled payments from Paypal. Removed personal identifiable information from the logs. | [PO-1026] [PC-18912] [PO-1058] [PO-1166] |
| 26 Sep 2022 | 22.0.236 | Fixed an error in the Moneris Checkout for Papercut MF/NG versions 19.x and 20.x. For Realex gateway use their hosted page for billing info validation. | [PO-1047] [PO-543] |
| 08 Sep 2022 | 22.0.230 | Fixed a typo in the Moneris Checkout configuration file. | [PO-1025] |
| 31 Aug 2022 | 22.0.229 | Realex Payment Gateway 3D Secure - We’ve added a new form to the Realex Payment Gateway to comply with new Strong Customer Authentication (SCA) regulations in the European Union. Added the Moneris Checkout payment gateway. | [PO-59] [PO-938] |
| 27 Jan 2022 | 21.2.219 | Updated to remove log4j from the Payment Gateway module install. The payment gateway will use whatever version is installed as part of the App Server installation. | [PO-749] |
| 20 Dec 2021 | 21.2.214 | Updated with log4j version 2.17. | [PO-698] |
| 17 Dec 2021 | 21.2.213 | Updated with log4j version 2.16. | [PO-697] |
| 10 Nov 2021 | 21.2.210 | Fixed keyword when writing to the user’s transaction log. Corrected log levels (previously all messages output as error). | [PO-439] [PO-515] |
| 4 Nov 2021 | 21.2.207 | Updated Network API Payment Gateway to not log errors on receiving a 404 response from the remote server. Note: Module starts including log4j*jar files in the build (not used actively) | [PO-552] |
| 14 Oct 2021 | 21.1.202 | Made Network Payment Gateway balance check more tolerant of integer balance values. | [PO-377] |
| 14 May 2021 | 21.0.185 | Improvements to the handling of the HPP_KEY when using the Moneris payment gateway. | [PO-240] |
| 20 Nov 2019 | 20.0.150 | Functionality added for developers who need to provide a custom job payment integration. | [PC-15212] |
Determining which Payment Gateway version is running
See How to check PaperCut NG/MF component version numbers (Payment gateway module version) for more information on how to see which version of the payment gateway module you have installed.
Category: How-to Articles
Subcategory: Charging and Billing, Installing, Uninstalling and Migrating
Keywords: payment gateway, documentation, payment documentation, payment gateway manual, setup instructions, installation, download, enable, guide
Comments