Retrieve a POS device

Point-of-sale devices/

Request

This endpoint retrieves the details of a specific point of sale device by its merchant ID.

Path

sitestringrequired

The ID of the site where the point of sale is located.

Example:SITE-1

merchantPointOfSaleIdstringrequired

The unique merchant identifier for the point of sale device.

Example:POS-12345

curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/SITE-1/POS-12345

Responses

Successfully retrieved the point of sale device details.

Bodyapplication/json

sitestring

The ID of the site where the point of sale will be deployed.

Example:"SITE-1"

serialNumberstring

The serial number of the point of sale device

Example:"SN1234567890"

merchantPointOfSaleIdstring

The unique merchant identifier for the point of sale device.

Example:"POS-12345"

pointOfSaleIdinteger, (int64)

The unique system identifier for the point of sale device.

Example:123456789

deviceModelstring

The model of the point of sale device.

Enum:"CastlesSaturn1000""ZebraTC510K""LandiP30SeriesWifiSim""LandiP30SeriesWifi""LandiP30SeriesWifiSimDS""LandiP30SeriesWifiDS""LandiP30DualWifiSim""LandiP30DualWifi""LandiP30DualWifiSimDS""LandiP30DualWifiDS"

Example:"CastlesSaturn1000"

communicationProtocolstring

The protocol used by the point of sale device.

Value:"HTTP"

Example:"HTTP"

communicationEndpointstring or null

The URL or network endpoint where the point of sale device actively listens for incoming connections and communications from the merchant system.

Example:"http://pos.example.com"

commercialModelstring or null

The commercial model for the point of sale device pricing.

Enum:"Onetime""Recurring""Financed""Both"

Example:"Onetime"

authenticationSettingsobject

The authentication settings for a point of sale device.

hostUrlsArray of objects or null

The endpoint URLs used by the PXP point of sale application

Example:

[
  {
    "url": "https://transaction.example.com",
    "urlType": "Transaction"
  }
]

logSettingsobject

The log settings for a point of sale device.

featureSettingsobject

The feature settings for a point of sale device.

storeAndForwardSettingsobject

The store and forward settings for a point of sale device.

statusstring

The status of the point of sale device.

Enum:"New""Pending""Active""Disabled"

Example:"Active"

createdOnstring, (date-time)

Example:"2023-09-01T12:00:00Z"

updatedOnstring or null, (date-time)

Example:"2023-09-10T15:00:00Z"

Response

{
  "site": "SITE-1",
  "serialNumber": "SN1234567890",
  "merchantPointOfSaleId": "POS-12345",
  "pointOfSaleId": 123456789,
  "deviceModel": "CastlesSaturn1000",
  "communicationProtocol": "HTTP",
  "communicationEndpoint": "http://pos.example.com",
  "commercialModel": "Onetime",
  "authenticationSettings": {
    "hmacKey": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
  },
  "hostUrls": [
    { … }
  ],
  "logSettings": {
    "verboseLoggingEnabled": true,
    "maximumLogSize": 10485760,
    "logFileCleanUpDays": 30
  },
  "featureSettings": {
    "statusPacketsEnabled": true,
    "languageSelectionEnabled": true,
    "gratuityEnabled": false,
    "onlinePinEnabled": true,
    "keyedEnabled": false,
    "dccEnabled": false
  },
  "storeAndForwardSettings": {
    "storeAndForwardEnabled": true,
    "transactionAmountThreshold": 10000,
    "throttlingLimit": 100,
    "processInterval": 300,
    "x509PrivateKey": "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC...",
    "x509PublicKey": "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE...",
    "keyGenerated": "2023-09-01T12:00:00Z"
  },
  "status": "Active",
  "createdOn": "2023-09-01T12:00:00Z",
  "updatedOn": "2023-09-10T15:00:00Z"
}