# 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.

{% if visitor.isSet === false %}
{% columns %}
{% column %}

<h4 align="center"><strong>Please login or register to gain access to the detailed material on this page.</strong></h4>
{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a><a href="https://partner-registration.verifone.com/" class="button secondary">Register for an Account</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

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

<table data-header-hidden><thead><tr><th width="486.046875" valign="top"></th><th></th></tr></thead><tbody><tr><td valign="top">Start with a supported Engage, Neo, or UX device. Load the CAM-XPI package before sending commands.</td><td><img src="/spaces/Vv7hHfN7Cbqq6eTt7D6r/files/90e43a2668207cd44c48d0407e59ddceaa2b3e8e" alt="M400 device" data-size="original"></td></tr></tbody></table>

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %} <a href="/pages/zArKtIo56odrL6Zh8R6J" class="button primary" data-icon="gear">Software Components</a>
{% endif %}
{% 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 %}

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %} <a href="/spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/QjBnKkJBk8WJ8woj5hM2" class="button primary" data-icon="gear">Communication Configuration</a>
{% endif %}
{% 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.

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %} <a href="/spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/ysrJJL91WX5Rsd2Yn52A" class="button primary" data-icon="gear">Communication Protocol</a>
{% endif %}
{% endstep %}

{% step %}

### Verify the connection

Goal: validate transport and app readiness.

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %}

1. Send [11 - PIN Pad Connection Test](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/292169fd2303c54538e16bfbffa01569bb16887b).
2. Send [M01 - Get Version Information](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/301a6dabd2f29ad95da7051a3dd78608d8828803).
3. Optionally initialize the idle prompt with [S01 - Query and Initialize Idle Prompt](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/9d96efb33e96bdccb9868ea6026e150d80077aab).

<a href="/spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/7e8829e58af53d757bfe2a3fc79ca22507c006de" class="button primary" data-icon="gear">Interface Command Set</a>
{% endif %}
{% endstep %}

{% step %}

### Run a first payment flow

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %}
A common EMV path is:

1. Start a session with [X00 - Start Transaction Session Request](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/2ab67d8ee96a7d31ed1292cfb3a3d85c8f4693a9).
2. Enable card entry with [C30 - Enable Card Insertion](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/JTZ6MwhxRmUsPu6AgxDY).
3. Start the EMV transaction with [C32 - EMV Transaction Request](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/0abecc3eada3dc3c602f7e9d1b82db88bc612638).
4. Complete the online step with [C34 - Complete Online EMV Transaction](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/fa79be4356e2c0489382d0c852335d53c2b4bbc7).
5. Cancel or reset the flow with [S00 - Cancel Command](broken://spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/3a8a64501485b10916980c06bc9e5a2c212240fe) when needed.

<a href="/spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/7e8829e58af53d757bfe2a3fc79ca22507c006de" class="button primary" data-icon="gear">Interface Command Set</a>
{% endif %}
{% 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.

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %} <a href="/spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/lMewsSrrElhPkTiwuNq9" class="button primary" data-icon="gear">INI File Configuration</a>
{% endif %}
{% endtab %}

{% tab title="Screen Templates" %}
Use screen templates to match standard prompts and UI flows on the device.

{% if visitor.isSet === false %}
{% columns %}
{% column %}

{% endcolumn %}

{% column %}

<p align="right"><a href="https://identity.verifone.com/am/XUI/?realm=/alpha&#x26;authIndexType=service&#x26;authIndexValue=DocsLoginV7&#x26;goto=https://docs.verifone.com/" class="button primary" data-icon="shield-keyhole">Login</a></p>
{% endcolumn %}
{% endcolumns %}
{% endif %}

{% if visitor.isSet === true %} <a href="/spaces/Vv7hHfN7Cbqq6eTt7D6r/pages/dYvvUnaKiLz5IajUXRgv" class="button primary" data-icon="gear">Screen Templates</a>
{% endif %}
{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.verifone.com/xpi/xpi-getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
