Menu

IPS Test Installation

The steps below guide you through a test installation. Use it to develop your POS integration with IPS or Mobile SDK, or work through your QA process. Before going live, Worldpay require you to complete theValidation Test. After validation you are ready to install the Production installations of IPS (more details coming soon).

IPS Setup in your environment – Testing with MUAT (Merchant User Acceptance Testing)

Before you start

To run IPS you need the following:

  • A Microsoft Windows or Linux platform:

    • Configure the Windows/Linux firewall to allow incoming payment terminal connection from your network on TCP port 9080

    • Configure the Windows/Linux firewall to allow incoming connection from your POS client on TCP port 7080

      (You can change these default ports if you want - seeInstallation Steps - Summarybelow).

  • Java 8 installed in your platform. Oracle Java, OpenJDK, and Amazon Corretto are all suitable

  • A WPT Test payment terminal. This is a payment terminal with test encryption keys connected to your network; for example e280 connected through Wi-Fi. Contact Worldpay to arrange Test payment terminals

  • Emboss MID (eMID) and TID(s) provided by your Worldpay Relationship Manager or Worldpay Customer Support

  • An FIS security certificate on your platform. Your Worldpay Relationship manager or Worldpay Customer Support will provide the FIS CA.zip file.

To import the FIS security certificate, do the following:

  1. Unzip FIS CA.zip to get the FIS Security Certificate.

  2. Open Run (Windows key + R) in Microsoft Windows.

  3. Type certmgr.msc and press Enter. The Certificate Manager window appears.

  4. Right click on Trusted Root Certification Authorities and then click All Tasks > Import.

  5. A window opens to add CA, select the FIS certificate, and import it.

Access to the WP MUAT (Merchant User Acceptance Testing) environment

You must have access to the Worldpay MUAT (Merchant User Acceptance Testing) environment from your Windows or Linux platform.

To check that you have access do the following:

  1. Browse to https://wpt-test.worldpaypp.com/soap/servlet/rpcrouter

  2. If the connection is successful, the response is:

SOAP RPC Router

Sorry, I don't speak via HTTP GET- you have to use HTTP POST to talk to me.

If it doesn't work - contact Worldpay.

Ensure you have established connections to all the VPNs, networks and so on

You must ensure that you have established connections to all the VPNs, networks, etc in your environment that are needed for the Merchant User Acceptance Testing.

An example payment device is theVerifone e280. The POS could be your Mobile Software Development Kit (SDK) or the Point of Sale (POS) test harness.

When IPS starts, it binds to the hostname of the platform. This can be a problem if the platform’s hostname then changes. This name change might occur if the platform connects to a Virtual Private Network (VPN) or another network. The problem is that IPS listens for connection requests targeted at the original hostname and ignores requests targeted at the new hostname.

If you're not sure what the hostname of your platform is, see theFind the hostname of your platformsection at the bottom of this page.

IPS "listens" on these TCP ports located on its host platform:

  • 9080 default for incoming TCP connections from payment devices

  • 7080 default for STOMP connection to/from the POS app, for example the Mobile SDK. The test client (supplied by Worldpay) also uses this port by default.

Check the network interface where IPS listens for http requests

For transaction requests and the Configuration Portal, IPS is accessible by default on the IP address of your platform's ethernet interface, for example Eth0.

If you want to access IPS on a different interface do the following:

  1. Use a command line parameter to specify the interface's IP address in the IPS start script. For example:

    start.bat server-host=127.0.0.1

For more information, see theInstall, start and register IPS from the zip filesection below.

Ensure you have user credentials to access the IPS Control Center

Use theIPS Control Centerto generate unique license codes. Without these codes the IPS and associated POS systems will not work.

The Worldpay Boarding Team or Worldpay Customer Support give you the information so you can log-in to the IPS Control Center. Use this URL to access the IPS Control Center:

https://ips-controlcenter.wpt-test.worldpaypp.com

Before you follow the instructions in the next section, make sure that have met all the requirements in the aboveBefore you startsection.

Installation steps - Summary

The detailed instructions below explain how to:

  1. Install, start and register IPS.
  2. Create and configure the pay points. After you install and register IPS, the second step is to create one or many pay points. To do this you can use the IPS Configuration portal (The URL is https://hostname:7080/ipc-app/portal/). This portal allows you to create pay points with a pre-set profile and view pay point details. You can also use the portal to delete pay points and view pay point and device pairs.
  3. Connect a Verifone e280 payment terminal to IPS. We use the e280 as an example, you can connect other devices. In this step you configure the e280 device(s) to connect to IPS.
  4. Pair the e280 payment terminal with a pay point. Once the e280 device has connected to IPS, the e280 displays on screen a list of available pay points. Available pay points are not already paired with some other device. Select the pay point you want, and the device and pay point are automatically paired. The pay point is then ready to process transactions. The connection between the e280 and pay point is maintained, even though the device may be switched off. The only way to unpair the two is to use the IPS Configuration Portal.
  5. Finally run a test transaction through the Test POS client.

Follow all the detailed steps below under all the headings to achieve end-to-end configuration and process a test transaction.

Install, start and register IPS from the zip file

Follow the instructions below, Worldpay will provide you with a zip file location:

  1. Download the zip file Worldpay provided and unzip it. The zip file creates the ipc-3-app folder.

  2. If not already present, download and install Java 8 for your platform. Oracle Java, OpenJDK and Amazon Corretto are all suitable. Set the location of the Java.exe and Javaw.exe executable in the PATH for the user account that is used to execute the IPS app.

  3. There is a special procedure if the machine that runs IPS does not belong to a domain (i.e the hostname or full computer name does not have a domain based name). In this case use the command start.bat server-host=<hostname>. otherwise double click on start.bat to start IPS.

    For example, start.bat

    Or start.bat server-host=x.x.x.x, if you want to change the network interface where IPS listens for the http request.

    Or start.bat server-port=yyyy device-port=zzzz, if you want to change the default TCP IP ports (server-port = TCP port to listen for incoming connection from POS client, the device-port is the TCP port that listens for the incoming connection from the Payment Terminal)

    Or start.bat server-host=x.x.x.x server-port=yyyy device-port=zzzz if you want to change the network interface and default TCP IP ports at the same time.

  4. IPS starts silently, but two events occur:

    a. IPS creates an app.pid file that contains an in-process ID number.

    b. IPS writes messages to the log file: logs/ipc-starting.log

    You know that IPS has successfully started from the logfile message TCP IP Server is started on port 9080.

  5. For the fresh installation of IPS (That means IPS is not registered and the SSL certificate not imported). Go to the Configuration Portal (non-secure): http://hostname:7080/ipc-app/portal/

    Or

    http://x.x.x.x:yyyy/ipc-app/portal/

    Where hostname is your hardware platform's hostname or x.x.x.x is the IP address of your platform's interface where IPS is listening for http and yyyy is the port.

    Note 1: When you access the above URL, if you are redirected to the secure configuration portal URL, clear the browser cookies, and try the URL again.

    Note 2: Once IPS is registered and the SSL certificate is imported, the IPS configuration portal starts on the secure URL: https://hostname:7080/ipc-app/portal/

  6. IPS checks for a stored license (IPS license) in the IPS folder. The IPS License is a unique reference and is stored within IPS. IPS must have access to the IPS License before you can use the various IPS functions.

  7. If IPS finds the stored IPS license the Configuration Portal homepage appears and IPS is ready to be configured. You can go direct to theAdd one or more pay pointssection below and follow the instructions there.

  8. If IPS cannot find a license, a pop-up appears - see theIf IPS does not find a licensesection below.

If IPS does not find a license

If IPS cannot find a license this pop-up appears:

Payment Application Registration pop-up

Now follow this procedure to get an IPS activation code:

  1. Click the URL link at the top of the pop-up. You are taken to the IPS Control Center.

    Known Defect - The IPS URL in the Configuration Portal redirects to the production IPS Control Center. To get IPS and POS activation codes for testing with MUAT go to: https://ips-controlcenter.wpt-test.worldpaypp.com/

  2. Login to IPS Control Center with the credentials given to you by the Worldpay Boarding team.

  3. Go to IPS > IPS Activation.

  4. Select the Emboss MID that appears in the drop-down list. Your Worldpay Relationship Manager or Worldpay Support supply this Emboss MID code.

  5. Enter the IPS Reference - Enter a name or code that identifies the IPS server and its location to you. For example, BONDFLR01 could stand for the IPS server in the Bond Street store, on floor 1.

  6. Click Submit

The IPS Control Center displays:

  • Emboss MIDs - Confirmation of the Emboss MID

  • IPS Reference - The payment reference you entered

  • IPS ID - Automatically generated by the system for registration purposes

  • IPS Activation Code - This is for registration purposes only and serves as a one-time passcode (OTP) to ensure high security

Make a note of all four of the values in Step 6 above.

What is the IPS Activation code for?

You need this code to generate an IPS License.

Loading the IPS Activation code

  1. Copy and paste the IPS ID, IPS Reference (Application Reference) and IPS Activation code into the IPS pop-up screen.

  2. Click Register.

  3. IPS automatically connects to the IPS Control Center in the background and acquires the IPS License.

  4. After successful registration the SSL process starts. Wait for approximately one minute - the server automatically restarts in the background.

  5. After the server restarts, you are redirected to the homepage of the IPS configuration portal (secure URL: https://hostname:7080/ipc-app/portal/) that you wanted to access in step 5 of theInstall, start and register IPS from the zip filesection above.

Add one or more pay points

To add a new pay point:

  1. From the Home screen, click + Pay Point at the top left of the screen. The Add a Pay Point screen appears.

    Add a new pay point screen

  2. Complete the fields. Worldpay provide the Terminal Identification (TID) number and the Merchant ID (MID).

  3. Select a profile from the Profile drop down or click +Add Profile to add another profile. When you add a new profile, select the Copy settings from another profile drop down. This displays all the available profiles. You can select a suitable profile to use to customize the profile attributes.

  4. Click Add to add this customized profile to the system.

  5. Once you create a profile, you can assign the same profile to different pay points.

  6. Click Add to add the new pay point to IPS; your pay point is created.

Configure the Verifone e280 Device(s) to connect with IPS

Follow the instructions to connect the e280 device to the Wi-Fi. Then set network parameters so that the e280 is configured to connect as a TCP client to the platform. We assume that IPS is set to "listen" on port 9080.

Configure the e280 to connect to the Wi-Fi

We use theVerifone e280as an example here. We could have equally chosen theP400or another device.

To connect the e280 to Wi-Fi, do the following:

  1. Enter the e280 Engineering menu (Password for test terminals = 12345678)

  2. From the Engineering menu, select Connection Setup.

  3. Select the Network (CCP) option.

  4. Select the Wi-Fi option.

  5. Select the Configuration option.

  6. Select the Wi-Fi Scan option.

  7. Select your Wi-Fi network from network scan list and select Add.

  8. A prompt appears to enter the pre-shared key. Enter the Wi-Fi password and press OK.

  9. Press Save. The e280 confirms with a Network Saved message.

  10. Press OK. The e280 displays an Apply Settings on Interface? message.

  11. Press Yes. The e280 connects to the Wi-Fi and confirms with an Interface Started message.

  12. Press OK.

  13. Exit back to the Connection Setup menu.

Configure the e280 to connect to the IPS Platform

While you are in the early stages of getting the IPS and e280 device connection working on your network, we recommend that you follow the steps below.

These steps show you how to configure the e280 with auto-connection mode DISABLED. This is because when auto-connection is on, and the device fails to connect it can take several attempts to return to the Engineering menu.

Once you have successfully connected the e280 with IPS, we recommend for ease of subsequent use, that you ENABLE auto-connection mode. Do this after you have followed the special instructionsE280 configuration with auto-connection ENABLEDat the end of this section.

E280 configuration with auto-connection DISABLED
  1. From the Engineering menu, select the Connection setup menu.

  2. Select the Connection option.

  3. At the Chose comm field, select WiFi.

  4. At the Enable SSL field, select No.

  5. At the TCP Mode field, select Client.

  6. At the Host Setup field, select Add host.

  7. Enter the IP address of the Windows platform, for example 192.168.1.210. Note: The . character is located within the abc option of the onscreen keyboard.

  8. Press Accept.

  9. At the Port No field, enter the number of the port IPS uses to 'listen' for incoming information from terminals. The default is 9080. You return to the Host Setup menu.

  10. Select Exit.

  11. Press the Exit 'soft' button (<) at the top left of the e280 screen repeatedly to go back and exit from the Engineering menu.

The e280 payment device displays a message: Press Enter to begin transaction.

E280 configuration with auto-connection ENABLED
  1. From the Engineering menu, select the Connection setup menu.

  2. Select the Connection option.

  3. At the Chose comm field, select WiFi.

  4. At the Enable SSL field, select No.

  5. At the TCP Mode field, select Client.

  6. At the Host Setup field, select Add host.

  7. Enter the IP address of the Windows platform, for example 192.168.1.210. Note: The . character is located within the abc option of the onscreen keyboard.

  8. Press Accept.

  9. At the Port No field, enter the number of the port IPS uses to 'listen' for incoming information from terminals. The default is 9080. You return to the Host Setup menu.

  10. Select the Auto Connection option and select Enabled.

  11. Enter a non-zero Timeout value, for example 2 seconds. You return to the Host Setup menu.

  12. Select the exit option.

  13. Press the Exit 'soft' button (<) at the top left of the e280 screen repeatedly to go back and exit from the Engineering menu.

The e280 now attempts to automatically connect to IPS. The message Connecting appears on the device screen.

If it fails to connect, the e280 will cycle continuously to attempt a connection. The Connecting message appears, followed by Connection Error if it fails to connect, followed by Waiting to connect.

Pair the pay points with the e280 Device(s)

If the payment terminal has Auto Connection enabled, it connects direct to IPS once a pay point is available.

If Auto Connection is not enabled, the message Press Enter to Begin Transaction Prompt on the payment terminal screen. Do the following:

  1. Press Enter. The payment terminal connects to IPS on port 9080 and prompts you on the screen to select Instance from a list of available pay points.

  2. Select your Pay point, the payment terminal then displays the message Do you want to connect device with [Pay point name (TID)]

  3. Press YES.

IPS downloads the configuration to the payment terminal and restarts the payment terminal. You see a series of screens displayed on the payment terminal starting with Loading Configuration. The final screen is Starting Comms Please wait as the payment terminal re-connects to network. The payment terminal screen goes completely blank for a short time a couple of times during its startup sequence.

During the restart the connection between IPC and the payment terminal is terminated.

If Auto-Connection is enabled the payment terminal automatically connects with IPS when the payment terminal has restarted.

  1. If Auto-Connection is not enabled, you will see the message Press Enter to Begin Transaction. Press Enter and the payment terminal re-connects to IPS.

When successful connection is established the Worldpay from FIS welcome screen appears on the payment terminal, showing the IPS version number. The Pay Point name appears towards the bottom of the payment terminal screen.

Use the test POS client to run the transaction

Use the POS Test client to test and trouble-shoot your system.

You do not have to use it, and it is not needed if you integrate through the Mobile SDK. This is because the Mobile SDK connects to IPS to place transaction requests.

To access the POS Test client through a browser, do the following:

  1. Enter https://<hostname>:7080/ipc-app/NewStompTestClient.html in your browser.

    • Where <hostname> is the fully qualified domain name of your machine that runs IPS

    • If you have passed the server-host parameter while starting IPS, then replace <hostname> with the value of server-host

      The test client directs transaction requests to an individual pay point according to the URL specified for the request.

      A default URL is provided with the default pay point name INST1.

  2. Replace INST1 with your own Pay Point name, for example ws://hostname:7080/ipc-app/payment/MyPaypoint_name

In the screenshot below, the INST1 pay point name has been replaced with attic01.

Test POS Client URL

Generate the Point of Sale Activation Code

What is the Point of Sale Activation code for?

You need this code to generate a POS License. The system needs a POS License for API requests to be accepted. The POS License is also needed for connections to the Worldpay Total API (for both mobile and direct integrations). No requests are accepted without this POS License.

Now you must use the IPS control centre to generate the Point of Sale Activation Code.

Remember to access the test control center at: https://ips-controlcenter.wpt-test.worldpaypp.com

To generate a point of sale activation code, do the following:

  1. In the IPS Control Center, go to Point of Sale > Point of Sale Activation.

  2. Check the Emboss MID in the drop-down list. It should be the same as the Emboss ID given to you by your Worldpay RM or Worldpay Customer Support.

  3. Enter the Point of Sale reference for this POS. This can be any name or reference code that identifies the platform or location where the POS app is installed. For example, the code DEP1-GF-REG1 might stand for the Department 1, ground floor, cash register 1.

  4. Click Submit.

The IPS Control center provides the details you need:

  • Emboss Merchant ID - Conformation of the code for the Emboss MID

  • POS Reference Code - Confirmation of the name or code you entered in Step 3 above.

  • POS ID - This is for Worldpay to reference and track POS registrations for internal consolidation and reconciliation

  • POS Activation Code - Used for registration purposes only and serves as a one-time passcode (OTP)

Make a note of all four of the values above.

Generate the POS License

To generate POS license, do the following:

  1. Open a web browser and enter this URL https://hostname:7080/ipc-app/NewStompTestClient.html

  2. Select the Request Type as Generate POS License.

  3. Enter the same pay point name that you created in earlier steps, in the endpoint URL.

  4. Enter Point of Sale Activation details you kept above and click Generate POS License. Here is an example of the code:

{

"pointOfSaleId": "YoKOYA"

"pointOfSaleReference": "IPC3POSRef"

"pointOfSaleActivationCode": "43kN5XXx"

}

Now click Show Response to get the POS License. For example:

{

"pointOfSaleLicenseKey": “String X"

}

  1. Store POS License: the value returned in pointOfSaleLicenseKey as it is needed for each transaction request. This value is alphanumeric and has a maximum length of 4096 bytes (ASCII characters).

  2. Delete the Test Client's default entry in the Authorization header field.

  3. Enter the POS License in the Authorization header. See screenshot below.

    POS license authorization header

Once you have entered the POS license key into the header, do the following to send a test transaction through the system you have just installed:

  1. At the Payment Type field, select Sale/Refund and click Start Transaction. IPS now sends a transaction request for 10.99 to the pay point.

As the transaction proceeds the Test Client displays the messages IPS sends to inform POS of the progress of the transaction.

Once the transaction is complete you can view the Cardholder and Merchant receipts. You can also see the IPS output response message. See the screenshot below:

Test transaction complete

You are now ready to start testing your POS application with this IPS installation. Remember that when you use your POS application you must send the POS License generated above with every transaction request to IPS.

Find the hostname of your platform

This is an information section, not part of the installation steps above.

You need the hostname of your platform for testing. You also need it to avoid the possible start problem described in theEnsure you have established connections to all the VPNs, networks and so onsection. To find the hostname of your platform do the following:

For Windows operating systems:

  1. Open a CMD window and enter hostname at the prompt. The result on the next line of the window displays the hostname.

For Linux operating systems:

Note: Linux implementations vary – see the documentation for your Linux variant. The instructions below apply for most Linux variants.

  1. Open a Terminal window and enter hostname at the prompt. The result on the next line of the window displays the hostname of your platform.