Platform Docs

Configuring Secure Network Pay Display

SNPD has several configuration options that can be set as required for your integration.

Opening the options page

To open the options page, do the following.

  1. Open the Network Pay Display app.
  2. Tap the menu icon and then tap Settings.
    The Clover Device Server settings appear.
Clover Device Server settings page

Clover Device Server settings page

Changing the connection protocol

By default, the connection between a POS and Clover device is over WebSocket Secure (WSS). The Clover Device Server also supports an unecrypted WebSocket (WS) connection. To change the connection type, complete the following steps.

IMPORTANT

A non-secure WS connection should only be used if needed for development and testing. WSS connections must be enabled in production.

  1. Tap the Server is Secured check box.
  2. Tap Configure and Restart Server.
    The lock icon changes from green to red. On the Network Pay Display screen, the device URLs change from wss:// to ws://.
WebSocket (WS) settings

WebSocket (WS) settings

Changing the server port

By default, the connection between a POS and Clover device uses port 12345. The port can be modified by doing the following.

  1. Tap Server Port.
  2. On the Enter Server Port Number window, type a new port number.
  3. Tap Save.
  4. Tap Configure and Restart Server.
    The port change is applied.

NOTE

If the new port is used by another process on the Clover device, an Address already in use message appears. To correct this issue, repeat the previous steps using a different port number.

Ping settings

To change the device's ping settings, modify one or more of the following values.

Setting
Description

Enable Ping

When checked, the device checks that the connection is open at the specified interval

Ping Interval

The length of time between pings (in milliseconds)

Ping Retry Before Disconnect

The number of times the server will attempt to ping the client before disconnecting

Changing the length of auth token validity

The number of days a pairing code is valid can be set for your environment. Once the interval elapses, a new code must be entered.

  1. Tap Auth tokens valid for.
  2. On the Enter # of Days window, change the number and then tap Save.
  3. Tap Configure and Restart Server.
    The validity interval is changed.

Device pairing screen

Enabling the pairing screen

You can choose to display a screen which provides three ways to pair the device: a QR code, the device's DNS name, and the device's IP address.

  1. Tap the Enable pairing screen check box.
  2. Tap Configure and Restart Server.

Using the pairing screen

If the pairing screen is enabled, the Initiate Pairing button appears on the Network Pay Display screen. Tap Initiate Pairing to show the pairing screen.

Initiate Pairing button

Initiate Pairing button

Device server certificates

To establish trust between the POS and the device server certificate issued by the Clover CA, you must install a Clover Device Server Root CA certificate on the POS. Clover provides separate certificates for development and production use.

IMPORTANT

The certificate must be installed in the Trusted Root Certification Authorities store. If the certificate is not installed in the correct store, a certificate chain error message appears when you attempt to connect.

Sandbox (development)

The device server certificate is issued by the Clover Device Server Root CA. The CA certificate is hosted at:

https://sandbox.dev.clover.com/v2/device_ca_certificate
https://sandbox.dev.clover.com/v2/device_ca_certificate.der
https://sandbox.dev.clover.com/v2/device_ca_certificate.crt

Production

The device server certificate is issued by the Clover Prod Terminal Server Root CA. The CA certificate is hosted at different locations for each region (US, EU, and Latin America):

https://www.clover.com/v2/env_device_ca_certificate
https://www.clover.com/v2/env_device_ca_certificate.der
https://www.clover.com/v2/env_device_ca_certificate.crt
https://www.eu.clover.com/v2/env_device_ca_certificate
https://www.eu.clover.com/v2/env_device_ca_certificate.der
https://www.eu.clover.com/v2/env_device_ca_certificate.crt
https://www.la.clover.com/v2/env_device_ca_certificate
https://www.la.clover.com/v2/env_device_ca_certificate.der
https://www.la.clover.com/v2/env_device_ca_certificate.crt

Changing the device certificate for development

By default, the device server certificate is issued by the Clover Prod Terminal Server Root CA. When you are working in the sandbox environment, change your CA using the following steps:

  1. In the SNPD app settings, select the Enable Development Certificate option.
  2. Select Configure and Restart Server. Once the server is restarted, the CA is updated.
  3. Select View Certificate Details and verify that the device certificate is issued by the Clover Device Server Root CA.

Viewing the current certificate

To see the complete device certificate, tap View Certificate Details.


Configuring Secure Network Pay Display


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.