Skip to main content

Obtaining Payment Device Information

Updated

Table of Contents

  1. Overview
  2. Serial Numbers
  3. COM Ports

Overview

When utilizing the Payment Device SDK for Windows, you will need to provide some additional device information in order to successfully connect a payment device with the SDK. If improper/incorrect information is provided within this file, the Payment Device SDK may return errors due to it being unable to connect to the payment device.

This article will highlight where to gather specific device information which maybe need for the Payment Device SDK for Windows/Linux. We will go over obtaining the following items from your payment device:

  1. Device Serial Numbers
  2. Device COM Ports

Serial Numbers

When obtaining a payment device from a partnered device distributor or directly from the gateway you should receive the payment device with the serial number added to a sticker on the device. This may differ per device distributor and device. 

Ingenico Lane Series

The Ingenico Lane Series share similar serial numbers, most Lane devices when purchased will show the serial number of the device on the back of the payment device. The sticker will show the serial number under the IPSN. Typical Lane Series serial numbers will begin with a 3 and are 16 numerical digits in length. Here is an example of how the serial number would appear:

IPSN: 3xxxxxxxxxxxxxxx

Miura M02x

The Miura M02x payment devices show the device serial number on the bottom/back of device. The sticker will include the Miura logo and barcode. Above these two images is the payment device's serial number. The serial number will begin with a 02x (M020's will utilize 020, while M021's will utilize 021) and include a '-', together the Miura M02x device's should have a serial number of 9 digits (not including the '-'). Here is how the serial number should appear on the device:

S/N: 020-xxxxxx or 
S/N: 021-xxxxxx

 

COM Ports

The Payment Device SDK for Windows/Linux, will request that a COM port is shared in order to complete the device connection to the host machine. A COM port is simply an I/O interface that enables the connection of a serial device to a computer. This will be needed within the configuration file as it specifies to the Payment Device SDK where the device is connected.

How to find a Device's COM Port (Windows) 

In order to find the COM Port the payment device will first need to connect to the Windows host machine. This will install any needed drivers for the device and assign the device a COM Port. To locate exactly what COM Port the device is using follow these steps:

  1. Once the Windows machine is running plug in the payment device into the computer.
  2. Open the device manager for the Windows machine.
  3. In the device manager expand the Ports (COM & LPT) to find your device, it should be labeled as USB Serial Device.

How to Identify a Device's Port (Linux)

When utilizing the Payment Device SDK for Linux, integrators will need to locate the Linux device file associated with the port being used by the payment device. This means that rather than a port number, Linux will utilize a file location. Here is an example of how a VCOM device file should appear:

/dev/ttyUSB0

Additionally, some payment devices which make use of USB on Linux can be assigned different port names and numbers when they are disconnected, then reconnected. This could cause issues with integrations if not handled properly and will need to be addressed by setting a static serial port within Linux for the payment device. Here are some steps to create a static virtual serial port:

  1. Run $ dmesg | grep tty Check the ttyACMx where x is the current ACM
    number associated with the device's physical port.
  2. Run $ udevadm info /dev/ttyACMx Check the ID_PATH e.g.
    platform-3f980000.usb-usb-0:1.y:1.0 where y is the number of the physical
    port currently used.
  3.  Navigate to /etc/udev/rules.d and create a .rules file.
  4. Add SUBSYSTEM=="tty", ENV{ID_PATH}=="platform-3f980000.usb-usb-0:1.y:1.0",
    SYMLINK+="xxxxxx"     where xxxxxx is a perferred name set by the integrator.
  5. Run $ sudo udevadm control --reload-rules && sudo service udev
    restart && sudo udevadm trigger     to update the rules with the new one.
  6. Now xxxxxx should always be assigned to usb port y and can be specified as the
    port name in the Server config file as /dev/xxxxxx