Manage POS devices

Operations

Add a POS device

Request

This endpoint is used to initiate a new point of sale device for a specific site. It creates the device with the provided configuration settings.

Path

sitestringrequired

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

Example:SITE-1

Bodyapplication/jsonrequired

Configuration details for the new point of sale device.

serialNumberstringrequired

The serial number of the point of sale device

Example:"SN1234567890"

merchantPointOfSaleIdstringrequired

The unique merchant identifier for the point of sale device.

Example:"POS-12345"

deviceModelstringrequired

The model of the point of sale device.

Enum:"CastlesSaturn1000""ZebraTC510K"

Example:"CastlesSaturn1000"

communicationProtocolstringrequired

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"

authenticationSettingsobjectrequired

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.

curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/SITE-1 \
  -H 'Content-Type: application/json' \
  -d '{
    "serialNumber": "SN1234567890",
    "merchantPointOfSaleId": "POS-12345",
    "deviceModel": "CastlesSaturn1000",
    "communicationProtocol": "HTTP",
    "communicationEndpoint": "http://pos.example.com",
    "commercialModel": "Onetime",
    "authenticationSettings": {
      "hmacKey": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
    },
    "hostUrls": [
      {
        "url": "https://transaction.example.com",
        "urlType": "Transaction"
      }
    ],
    "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"
    }
  }'

Responses

Successfully initiated the point of sale device.

Bodyapplication/json

statusstring

The status of the point of sale device.

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

Example:"Active"

sitestring

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

Example:"SITE-1"

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

Response

{
  "status": "Active",
  "site": "SITE-1",
  "merchantPointOfSaleId": "POS-12345",
  "pointOfSaleId": 123456789
}