> For the complete documentation index, see [llms.txt](https://docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verifone.com/xpi/xpi-getting-started.md).
# 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.
{% columns %}
{% column %}
Please login or register to gain access to the detailed material on this page.
{% endcolumn %}
{% column %}
LoginRegister for an Account
{% endcolumn %}
{% endcolumns %}
The host starts every action. The device stays in receiving mode and responds to commands.
{% hint style="warning" %}
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.
{% endhint %}
### Set up your first connection
{% stepper %}
{% step %}
### Confirm the device and package
| |
|---|
| Start with a supported Engage, Neo, or UX device. Load the CAM-XPI package before sending commands. |  |
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endstep %}
{% step %}
### Configure communication
Pick one transport first. XPI supports RS232, USB, WiFi, Ethernet, Bluetooth, and WebSocket.
{% hint style="info" %}
For IP and WebSocket, the default port is `12345`. For Engage and UX serial communication, the default format is `8n1` at `115200`.
{% endhint %}
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endstep %}
{% step %}
### 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.
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endstep %}
{% step %}
### Verify the connection
Goal: validate transport and app readiness.
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endstep %}
{% step %}
### Run a first payment flow
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endstep %}
{% step %}
### Review configuration and UI behaviour
Review runtime settings and device prompts before broader testing.
{% tabs %}
{% tab title="INI Settings" %}
Use INI settings to control runtime behaviour.
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endtab %}
{% tab title="Screen Templates" %}
Use screen templates to match standard prompts and UI flows on the device.
{% columns %}
{% column %}
{% endcolumn %}
{% column %}
Login
{% endcolumn %}
{% endcolumns %}
{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.verifone.com/xpi/xpi-getting-started.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.