Terminal-2 icon

Get the terminal ID

Get the unique identifier of the payment terminal to include in your Terminal API requests.

View source

When you make a Terminal API request, you need to indicate which payment terminal you want to use. To do so, you populate the POIID field in the MessageHeader with the unique identifier of the payment terminal in the format [device model]-[serial number]. For example, P400‑123456789.

There are several ways to get the unique ID (POIID) of a payment terminal:

Get the serial number from the terminal

To construct the POIID of the payment terminal:

  1. Find the serial number of the payment terminal:
    • On the back of the payment terminal.
    • On the payment terminal screen under Settings > Device info.
  2. Take the device model, for example, P400, and combine it with the serial number.
  3. Add a dash between the device model and the serial number.
  4. Remove any dashes from the serial number.

Get the serial number from your Customer Area

In your Customer Area:

  1. Go to In-person payments > Payment devices, and select the Terminals tab.
  2. Select the payment terminal.

Make an API call

If your integration uses cloud communications, you can get the terminal ID with an API call:

  1. Make a POST /connectedTerminals request, specifying your merchant account and optionally a store belonging to that merchant account.
  2. In the response, get the POIID from the uniqueTerminalIds array.
    This array contains a POIID for every terminal that has a live cloud connection and belongs to the specified merchant account or store.

Use a diagnosis request

If your integration uses local communications, you can get the terminal ID using a diagnosis request.

  1. Make a diagnosis request with a placeholder MessageHeader.POIID, for example xxxx-123456789.
    The request will fail.

  2. In the DiagnosisResponse, find the correct POIID inside the MessageHeader.
    This is the POIID of the terminal that you sent the diagnosis request to.

Use an Android function

For Android payment terminals with your app installed on the terminal:

  • Get the POIID of the terminal by calling the following function:

See also