SDK Guides / Terminal Administration - Android SDK

Intro

The terminal administration functionality can be used set specific local parameters of the payment terminal.

The parameters that can be set are:

• TerminalID (followed by an automatic installation);
• LocalNetworkData like:
• DHCP or Static mode;
• IPAddress;
• SubnetMask;
• Gateway;
• DNS1;
• DNS2;
• DisplayOrientation (IM15 only).

The use of this function has restrictions. It is a one-shot function meaning that it can be used only once in the lifetime of a terminal. To re-use this function the terminal must first be set to Factory Defaults in the local menu of the terminal. When it is used for the second time in its live time, this will result in an onError.

Terminal Administration

The following code snippet demonstrates how you can perform a terminal administration operation

    TerminalDelegate terminalDelegate = new TerminalDelegate() {

        @Override
        public void onPaymentAdministrationSuccess(PaymentAdministrationResult result) {
            //contains code which handles a successful terminal administration call
        }

        @Override
        public void onError(Error error) {
            //contains code which handles a failed terminal administration call
        }
    };

    TerminalApi terminalService = new TerminalService();

    TerminalLocalNetworkSettings localNetworkSettings = TerminalLocalNetworkSettings.builder()
                    .dhcp(false || true) // When DHCP is set to true the to other network settings will be ignored
                    .ipAddress("0.0.0.0") // valid examples 192.168.001.003 but 192.168.1.3 is also allowed
                    .subnetMask("0.0.0.0") // Valid examples 255.255.255.0 but 255.255.255.000 is also allowed
                    .gateway("0.0.0.0") // Valid examples 192.168.001.001 but 192.168.1.1 is also allowed
                    .dns1("0.0.0.0") // Valid examples 008.008.008.008 but 8.8.8.8 is also allowed
                    .dns2("0.0.0.0") // Valid examples 008.008.004.004 but 8.8.4.4 is also allowed
                    .build();

    TerminalAdministrationRequest terminalAdministrationRequest = TerminalAdministrationRequest.builder()
                    .terminalID("1234567")
                    .terminalLocalNetworkSettings(localNetworkSettings)
                    .displayOrientation(DisplayOrientation.PORTRAIT || DisplayOrientation.LANDSCAPE) (PAX IM15 only)
                    .build();

    terminalService.terminalAdministrationOperation(externalTerminal, terminalAdministrationRequest, terminalDelegate);