PUT devices/key

PUT /api/v2/paymentengine/devices/:devicekey:

Updates an existing device. Parameters are only updated if they are present in the body.

Request Parameters

Variable	Description
name	A name associated with the terminal. Device name can contain letters, numbers, spaces, and dashes. All other characters will be filtered out.
settings	Device settings
terminal_config	Terminal configuration

Device Settings

Variable	Description
timeout	Transaction timeout, how long to wait for transaction authorization to complete.
notify_update	If true, device will be notified on all future updates
notify_update_next	If true, device will be notified only on the next update. After notification, this is automatically set back to false.
enable_standalone	Allows transactions to be initiated from terminal (if supported).
share_device	If true, this allows the payment device to be used by other merchants. If false, only the merchant associated with the apikeyid may send transactions to device.
sleep_battery_device	This is the amount of inactive time (in minutes) before the device enters full sleep if it is running on battery. If in full sleep, you will need to turn the device on again before processing. Wifi and Bluetooth pairing should persist, even after full sleep. Set to '0' to never sleep.
sleep_battery_display	This is the amount of inactive time (in minutes) before the device enters display sleep if it is running on battery. If in display sleep, just send a transaction to the device or tap any button to wake the device. Set to '0' to never sleep.
sleep_powered_device	This is the amount of inactive time (in minutes) before the device enters full sleep if it is plugged into power. If in full sleep, you will need to turn the device on again before processing. Wifi and Bluetooth pairing should persist, even after full sleep. Set to '0' to never sleep.
sleep_powered_display	This is the amount of inactive time (in minutes) before the device enters display sleep if it is plugged into power. If in display sleep, just send a transaction to the device or tap any button to wake the device. Set to '0' to never sleep.

Terminal configuration

Variable	Description
enable_emv	Enables EMV processing.
enable_debit_msr	Enables PIN debit for swiped transactions.
enable_tip_adjust	Allows EMV transaction amounts to be adjusted after authorization (to add tip). Disables PIN authentication.
enable_contactless	Enables NFC reader.

Example Requests

Basic Request (curl)

curl --basic --user APIKEY:PINHASH \
 -X PUT \
 -H "Content-Type: application/json" \
 -d '{"name":"Testing","settings":{"share_device":true}}' \
 https://usaepay.com/api/v2/paymentengine/devices/sa_1BTTI5Yys0G3gVQa6beYxM4K0hhjC

Basic Request (json)

{
  "name": "Register 1",
  "settings":{
    "share_device":true
  }
}

Response

The response is the standard GET device response.

Example Response

{
  "type": "device",
  "key": "sa_WKwzyQawBG0RMy0XpDGFXb6pXA23r",
  "apikeyid": "ntC8nP31Moh0wtvYT",
  "terminal_type": "standalone",
  "status": "connected",
  "name": "Register 1",
  "settings": {
    "timeout": 30,
    "share_device": true,
    "enable_standalone": false,
    "sleep_battery_device": 5,
    "sleep_battery_display": 1,
    "sleep_powered_device": 0,
    "sleep_powered_display": 0
  },
  "terminal_info": {
    "make": "Castles",
    "model": "VEGA3000",
    "revision": "18043001-0055.00",
    "serial": "011118170300198",
    "key_pin": "FFFF5B04",
    "key_pan": "FF908A"
  },
  "capabilities": {
    "emv": true,
    "swipe": true,
    "contactless": true,
    "signature_capture": true,
    "printer": true,
    "pin": true,
    "sleep_battery": true,
    "sleep_power": true
  },
  "terminal_config": {
    "enable_emv": true,
    "enable_debit_msr": true,
    "enable_tip_adjust": true,
    "enable_contactless": true
  }
}