Device Settings

Get Device Settings

get

Retrieve the device configuration settings associated with a terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/settings/terminal/device

HTTPcURLJavaScriptPython

GET /rest/v2/settings/terminal/device HTTP/1.1
api-key: text
Accept: */*

{
  "payloadType": "text",
  "device": {
    "manufacturer": "text",
    "enabled": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "device-api-key": "text"
  }
}

Create Device Settings

post

Create the device configuration settings for a terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Contains the terminal device configuration settings.

manufacturerstring · enumOptional

Name of the device manufacturer associated with the terminal.

Example: textPossible values:

enabledboolean · enumOptional

Indicates whether the device configuration are enabled for terminals (true) or disabled (false).

Example: truePossible values:

device-api-keystringOptional

API key used to authenticate and associate the device with the system.

Example: text

Responses

200

ok

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/settings/terminal/device

HTTPcURLJavaScriptPython

POST /rest/v2/settings/terminal/device HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "manufacturer": "text",
  "enabled": true,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "device-api-key": "text"
}

{
  "payloadType": "text",
  "device": {
    "manufacturer": "text",
    "enabled": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "device-api-key": "text"
  }
}

Update Device Settings

put

Update the existing device settings for a terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Contains the terminal device configuration settings.

manufacturerstring · enumOptional

Name of the device manufacturer associated with the terminal.

Example: textPossible values:

enabledboolean · enumOptional

Indicates whether the device configuration are enabled for terminals (true) or disabled (false).

Example: truePossible values:

device-api-keystringOptional

API key used to authenticate and associate the device with the system.

Example: text

Responses

200

ok

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

put

/rest/v2/settings/terminal/device

HTTPcURLJavaScriptPython

PUT /rest/v2/settings/terminal/device HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "manufacturer": "text",
  "enabled": true,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "device-api-key": "text"
}

{
  "payloadType": "text",
  "device": {
    "manufacturer": "text",
    "enabled": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "device-api-key": "text"
  }
}

Delete Device Settings

delete

Delete the existing device settings for a terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

delete

/rest/v2/settings/terminal/device

HTTPcURLJavaScriptPython

DELETE /rest/v2/settings/terminal/device HTTP/1.1
api-key: text
Accept: */*

{
  "payloadType": "text",
  "device": {
    "manufacturer": "text",
    "enabled": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "device-api-key": "text"
  }
}