XPI Getting Started

CAM-XPI lets your host application control Verifone PIN pads and payment devices. It supports magnetic stripe, contactless, contact EMV, credit, debit, loyalty, and gift flows.

The host starts every action. The device stays in receiving mode and responds to commands.

Make sure the required keys are loaded before live testing.

Live PIN and card-data flows require the right keys on the device. Load debit and card-data encryption keys before production testing.

Set up your first connection

Confirm the device and package

Start with a supported Engage, Neo, or UX device. Load the CAM-XPI package before sending commands.

Configure communication

Pick one transport first. XPI supports RS232, USB, WiFi, Ethernet, Bluetooth, and WebSocket.

For IP and WebSocket, the default port is 12345. For Engage and UX serial communication, the default format is 8n1 at 115200.

Choose packet framing

By default, XPI uses STX, ETX, and LRC framing. This is controlled by the SAPF parameter.

SAPF=1 uses framed packets with ACK and NAK.
SAPF=0 uses raw packets without ACK and NAK.

Keep at least 100ms between requests and responses.

Verify the connection

Goal: validate transport and app readiness.

Run a first payment flow

Review configuration and UI behaviour

Review runtime settings and device prompts before broader testing.

Use INI settings to control runtime behaviour.

Last updated 24 days ago

Was this helpful?