Heartland is a legacy Datacap-family integration kept for existing merchants: install the Heartland NETePay bundle on Windows, load the Deployment ID, choose Heartland on the location and initialize the reader. A register with an IP Tran Device ID routes through IP Tran instead.

This is a legacy integration. PHP Point Of Sale no longer offers new merchant enrollments with Heartland Payment Systems; new stores should use PHP POS Payments — see choosing a payment processor. The Heartland option remains in the software, so existing Heartland merchants can keep processing with the setup below.

Heartland uses the Datacap pattern: a pin pad (Heartland historically shipped the Ingenico iPP320 for this integration) connected to a Microsoft Windows PC running Datacap NETePay and the dsiPDCX / dsiEMVUS listener. That software must be running at all times — if it is closed, card processing stops. The terminal hardware comes from Heartland directly, not from the PHP Point Of Sale hardware store.

Heartland technical support: 1-888-963-3600.

Install the bundled software

1. Download the Heartland NETePay installer bundle. The links in old enrollment letters may be stale; ask support for the current download if yours no longer works.
2. Double-click the executable and follow the on-screen prompts. The defaults, including the listener port of 3333, almost never need to be changed.
3. Restart the computer when the installer finishes; the software launches automatically after the restart.

The bundle installs three components: the terminal device driver, the Datacap dsiPDCX / dsiEMVUS listener, and the Datacap NETePay client — the last two are what communicate with Heartland. Your firewall must allow traffic on port 9000, and a working internet connection is required.

Set up NETePay

1. Double-click the NETePay icon on the desktop if it is not already open.
2. On first launch NETePay asks to obtain a serial number from Datacap's PSCS (Payment Systems Configuration Server). Click Obtain Serial Number — a 10-digit serial number is assigned. Click OK, then OK again on the dialog saying merchant parameters have not been retrieved yet.
3. Choose Setup → Merchant Parameters, click Load New Parameters, then Yes.
4. Click I have my DeploymentID and enter the Deployment ID from Heartland's technical support (or from PHP Point Of Sale support), then click OK. If you never received one, contact support so the merchant parameters can be created on the PSCS server first.
5. Verify the merchant demographic data. If it is wrong, click Cancel and repeat from step 3; if it is right, click Yes, This is the Correct Merchant.
6. Click OK back through to the main status window. NETePay is ready to process.

Configure the location

1. Go to Locations and click Edit next to the location that will take cards.
2. In the Integrations section, check Enable Credit Card Processing.
3. Set Credit Card Processor to Heartland.
4. Enter the EMV Merchant ID / Terminal ID exactly as shown at the top of your setup sheet.
5. Leave COM port at its default of 9 and Listener port at its default of 3333 unless your installer told you otherwise.
6. Leave Net E-Pay Server empty unless NETePay runs on a different machine than this register.
7. Click Submit to save, then click Initialize credit card reader. Initialization can take one to two minutes; wait for the success message.

Editing locations requires the Locations module permission on your employee account — see permissions and templates. Integrated processing also requires the POS to be served over HTTPS.

IP Tran variant

Heartland accounts can also run through an IP Tran device — a small box wired to your router with the terminal wired to it over serial, so any device on the network (including tablets) can share the terminal without a Windows listener. If a register has an IP Tran Device ID entered in the Registers table on the location form, sales at that register automatically route through the IP Tran device instead of the Windows listener. Cabling and per-register initialization are the same as described in Worldpay, Vantiv & Mercury setup.

Settings reference

• Enable Credit Card Processing — master switch, off by default.
• Credit Card Processor — set to Heartland.
• EMV Merchant ID / Terminal ID — from the setup sheet.
• COM port — default 9.
• Listener port — default 3333.
• Net E-Pay Server — only if NETePay is on another machine.
• EMV Device Override / Non EMV Device Override — leave empty unless your setup sheet names a device string.
• Integrated Gift Cards — only if your Heartland account includes processor gift cards; see gift cards.
• Use Integrated EBT — EBT through the terminal where the account supports it.
• Disable Amount Confirmation when processing credit card — skips the confirmation prompt before the terminal wakes.
• Per register in the Registers table: Terminal ID, Enable Tips, per-register device overrides, IP Tran Device ID, Pin Pad IP, Pin Pad Port, and Card Reader Actions.

After setup

Ring a small test sale and pay with Credit/Debit; the pin pad wakes with the exact amount. Everyday card flows — chip, tap, swipe, tips, voids, refunds, unconfirmed-transaction recovery — are in taking card payments; the shared setup concepts are in setting up credit card processing.

Common questions

Is Heartland still supported? Existing Heartland merchants can keep processing — the option is still in the software — but new enrollments are no longer offered. New stores should use PHP POS Payments.

Initialization fails with "Unable to initialize device." Confirm NETePay and the listener are running, the COM port is 9, the listener port is 3333, port 9000 is open in the firewall, and the terminal has power and its cable path to the PC.

Cards suddenly stopped working mid-day. Almost always the Windows PC: NETePay or the listener was closed, or the PC slept or rebooted. Reopen NETePay, then click Initialize credit card reader on the location before the next sale.

Can I use Heartland from an iPad or tablet? Only with the IP Tran variant, which moves the terminal onto your network. The standard listener setup is desktop-only.

Where do I get a Deployment ID? From Heartland's technical support, or from PHP Point Of Sale support if the parameters need to be created on Datacap's PSCS server.

Do refunds go back to the card? Yes — run the void or return from the original sale and the reversal goes through Heartland to the same card. See taking card payments.