Hi. How can we help?

Setting up a Worldline Yomani terminal on your iPad

You can set up a Yomani (non-mobile) payment terminal that runs a software version 14.06.00 or later to be used with Worldline payment processing on your iPad, provided you are using the Lightspeed Retail POS app.

Note: To check the software version of your terminal, power it on and press STOP (the red button at the bottom left) > 5 > Password > 5.

Yomani terminals connect to your iPad via LAN:

LAN Local Area Network: the terminal will be connected to your router by means of a LAN cable. Your iPad then connects to your terminal through the same network.


Note: If you purchased your Yomani payment terminal from a different supplier (other than Wordline itself), please contact Worldline to verify if the terminal can be attached to Lightspeed Retail POS - some suppliers block their terminals, which can't be connected to any POS system.

What you need 

Yomani payment terminal yomani-terminal-generic-shot.png
Power cable Yomani-power-cable.png
USB cable USB-cable.png

Setup steps

  1. Turning on your Yomani terminal
  2. Set Worldline as the Gateway in Retail POS
  3. Connect the Yomani terminal to your network (LAN)
  4. Include the terminal in the ECR Settings
  5. Attach the terminal to your iPad

Turning on your Yomani terminal

Connecting the cables

At the back of your Yomani XR terminal, you will find four communications interfaces as standard:

  • USB host (USB A) port
  • USB device (USB B) port
  • Ethernet port
  • Serial (RS-232) port

Connect the appropriate cables to your Yomani terminal in the following order:

  1. Plug the Ethernet cable (port 4), the serial RS-232 cable (port 1), or both.
  2. To connect your terminal to the iPad, plug the USB B connector of the USB cable
    into the USB B socket (port 3) on the terminal.
  3. If you are using a power adaptor to power your Yomani, plug the power cable from the adaptor into the corresponding power socket on the terminal (port 5).



Note: Only use the USB cable (type AWG20-28) supplied by your vendor. A cable length of 3m maximum is recommended.

Powering the terminal on

The Yomani terminal is normally powered on by simply connecting the power adaptor to the power input socket.


Alternatively, in case you are using the terminal without any of its accessories (such as a printer or a
communications interface board), you can power on your terminal by plugging it directly into the iPad's USB port.

Set Worldline as the Gateway in Retail POS

Note: Yomani terminals only work on your iPad when you access the Lightspeed Retail app in Manager mode. The POS view of the app does not work with this terminal.

  1. Open the Retail app and tap Retail Manager at the bottom right of the screen to view your POS in Manager mode.


  2. On the menu on the left, tap Settings.
  3. Under the Sales row, tap Payment Processing.


  4. Tap + Add a Payment Gateway.
  5. From the Select Gateway drop-down, select Worldline.
  6. From the sub-sections that appear, configure the following:
    • Assign a Name: Enter a unique gateway configuration name that is more intuitive to you (we recommend creating a separate gateway for each shop location).
    • Select Shops: Select the shop(s) that will be using this gateway to process payments.
    • Credit Card Payment Mapping: Map all card brands to their corresponding payment types to configure how they will appear in your reporting.
  7. Tap Save at the top left corner of the screen.
  8. Sign out of the Retail POS app and then sign back in to see your changes in effect.


Connect the Yomani terminal to your network (LAN)

  1. Connect the Yomani terminal with a LAN cable to your router.
  2. Power on the Yomani terminal by connecting the power supply.

Include the terminal in the ECR Settings

Your Yomani device works under a protocol called ECR. Ensure that this ECR protocol is set to CTEP. Doing so will allow Retail to communicate with your Yomani terminal.

  1. Press StopOK > Menu to access the terminal menu.
  2. Press 3 (Terminal Setup).
  3. Press 0 on the terminal's keypad to select option 10 (Next).
  4. Press 9 (Technician only).
  5. Enter the Technician only password: 1235789.
  6. Press OK.
  7. Press 4 (Hardware settings).
  8. Press 2 (ECR Protocol).
  9. Check the ECR Protocol. If it is not set as CTEP, press Change at the top right.
  10. Press 9 (CTEP).
  11. Press OK twice. You should be taken to the Communications menu.

Now that you are sure the ECR Protocol is set to CTEP on the terminal, follow the steps below to include it in the ECR settings.

  1. From the Communications menu, press 9 (ECR Physical Conf.).
  2. Check the ECR Physical Configuration. If it is not set as TCP/IP, tap Change at the top right.
  3. Press 2 (TCP/IP).
  4. Press OK for TCP Configuration Client.
  5. Enter the Hostname (IP address) of your iPad. Instead of using a dot, press OK after each portion of the IP address value.
    For example, if your IP address is 192 > OK > 168 > OK > 0 > OK > 123 > OK

Note: To view your iPad's IP address, tap Settings >Wi-Fi, then select the "i" icon in blue to display the network information.


  1. On the empty screen named Hostname, press OK.
  2. Enter the port number: 9000.
  3. Press OK. You should be taken back to the menu.
  4. Press Stop multiple times in order for the terminal to reboot.

Attach the terminal to your iPad

  1. Tap the Card Reader icon from the Main Menu.


  2. In the Device Settings section, tap Payment Terminal.


  3. Select Yomani to connect your iPad to the payment terminal. The terminal will then show as “Ready”.

Note: For all issues related to the payment terminal itself, contact Worldline Support directly.

What's next?

Was this article helpful?

0 out of 0 found this helpful