Function to update one or more settings for the device. Note that many settings are controlled centrally within the Kinetic system (all settings can be, however most settings revert to their default value when none is present), however the settings listed below are adjustable locally too.
Request
POST: https://ip-10-0-1-196.devices.kineticsmart.com:44443/api/v1/settings.json
Request body
Settings in the Kinetic system are simply a set of key:value pairs that are use to set up terminal, merchant, system and other parts of the application on the device. A number of the settings are set centrally and cannot be changed locally.
The body comprises only a list of key:value pairs for the settings you wish to adjust. For example:
{"device.name":"Kinetic Device"}
Response
For each settings that was updated, the device will return the key name with _updated:
{“device.name_updated”:true}
Available Settings
‘auth.user’, ‘auth.clear_password’: used to change the REST API username and password to reach the device.
‘connection.mode’: “wifi”, “ethernet”, “gsm”, force the connection type that the device is using.
‘device.keypad_backlight_enabled’, ‘device.keypad_backlight_timeout’: true/false and number in milliseconds. Control of the keypad backlight.
‘device.lcd_backlight_enabled’, ‘device.lcd_backlight_timeout’: true/false and number in milliseconds. Control of the display backlight.
‘device.name’: used to locally change the name of the device used when broadcasting status every three seconds on the network.
‘eth0.dhcp.enabled’, ‘eth0.autoconnect.enabled’, ‘eth0.static.ip’, ‘eth0.static.netmask’, ‘eth0.static.gateway’, ‘eth0.dns_ip’, ‘eth0.mac_address’: granular control of the Ethernet network environment settings.
‘keypad.beep.enabled’: true/false, device plays an audible beep when a key is pressed.
‘merchant.return_to_idle’: true/false, for integrated environments with transactions initiated via REST API, you can bypass the key prompts on the transaction result screen and move straight to the idle screen once an approved transaction is completed.
‘merchant.force_return_to_idle’: true/false, same as above except for any transaction result, not just approved transactions.
‘merchant.refund’: true/false, allow refunds to be performed on this device.
‘terminal.debug’: true/false, enable console logging output from the payment application for debug purposes. Use only when advise by the Kinetic team as enabling this will cause a noticeable degradation in device performance.
‘terminal.passcode’: minimum seven digit number, to change the passcode used when entering Manager Menu, initiating refund or close options on the device.
‘terminal.printer’: true/false, to override the device’s awareness of having a printer. This is useful on Vega3000 devices to prevent printing of a receipt on the device.
‘webserver.beacon.enabled’, ‘webserver.beacon.port’: true/false and number, these settings are used to override the UDP discovery broadcast that the device is running.
‘wifi.dhcp.enabled’, ‘wifi.autoconnect.enabled’, ‘wifi.static.ip’, ‘wifi.static.netmask’, ‘wifi.static.gateway’, ‘wifi.dns_ip’, ‘wifi.mac_address’: granular control of the Wi-Fi network environment settings.
‘wifi.ssid’, ‘wifi.password’: change the wifi network that the device is connected to. Note that this will also change the URL to reach the device for the next instruction.