Skip to content
Point-of-Sale devices
/
/
Update general settings

POS service API (1.0.0)

This is an API reference for the Point of Sale service, which allows you to manage point of sale devices, including their settings, activation, and configuration.

Download OpenAPI description
point-of-sale.json
point-of-sale.yaml
Languages
Servers
Production environment

https://api-services.pxp.io/api/v1/

Sandbox environment

https://api-services.test.pxp.io/api/v1/

Manage POS devices

Operations

Authentication settings

Operations

Feature settings

Operations

General settings

Operations

Create general settings

Request

This endpoint creates general settings for a specific site.

Path
sitestringrequired

The ID of the site where the settings will be applied.

Example: SITE-1
Bodyapplication/jsonrequired

The general settings to apply to the site.

serialNumberstringrequired

The serial number of the point of sale device to activate.

Example: "SN1234567890"
merchantPointOfSaleIdstring or null

The unique merchant identifier for the point of sale device.

Example: "POS-12345"
deviceModelstring(DeviceModels)required

The model of the point of sale device.

Enum"CastlesSaturn1000""ZebraTC510K"
Example: "CastlesSaturn1000"
communicationProtocolstring(CommunicationProtocols)required

The protocol used by the point of sale device.

Value"HTTP"
Example: "HTTP"
communicationEndpointstring or null(CommunicationEndpoint)

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"
curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/SITE-1/general-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "serialNumber": "SN1234567890",
    "merchantPointOfSaleId": "POS-12345",
    "deviceModel": "CastlesSaturn1000",
    "communicationProtocol": "HTTP",
    "communicationEndpoint": "http://pos.example.com"
  }'

Responses

Successfully created the general settings.

Bodyapplication/json
statusstring(Status)

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
application/json
{
  "status": "Active",
  "site": "SITE-1",
  "merchantPointOfSaleId": "POS-12345",
  "pointOfSaleId": 123456789
}

Get general settings

Request

This endpoint retrieves the general settings for a specific point of sale device.

Path
pointOfSaleIdinteger(int64)required

The unique system identifier for the point of sale device.

Example: 123456789
curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/general-settings

Responses

Successfully retrieved the general settings.

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(DeviceModels)

The model of the point of sale device.

Enum"CastlesSaturn1000""ZebraTC510K"
Example: "CastlesSaturn1000"
communicationProtocolstring(CommunicationProtocols)

The protocol used by the point of sale device.

Value"HTTP"
Example: "HTTP"
communicationEndpointstring

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"
statusstring(Status)

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
application/json
{
  "site": "SITE-1",
  "serialNumber": "SN1234567890",
  "merchantPointOfSaleId": "POS-12345",
  "pointOfSaleId": 123456789,
  "deviceModel": "CastlesSaturn1000",
  "communicationProtocol": "HTTP",
  "communicationEndpoint": "http://pos.example.com",
  "status": "Active",
  "createdOn": "2023-09-01T12:00:00Z",
  "updatedOn": "2023-09-10T15:00:00Z"
}

Update general settings

Request

This endpoint updates the general settings for a specific point of sale device.

Path
pointOfSaleIdinteger(int64)required

The unique system identifier for the point of sale device.

Example: 123456789
Bodyapplication/jsonrequired

The updated general settings.

sitestring or null

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

Example: "SITE-1"
serialNumberstring or null

The serial number of the point of sale device

Example: "SN1234567890"
merchantPointOfSaleIdstring or null

The unique merchant identifier for the point of sale device.

Example: "POS-12345"
deviceModelstring(DeviceModels)

The model of the point of sale device.

Enum"CastlesSaturn1000""ZebraTC510K"
Example: "CastlesSaturn1000"
communicationProtocolstring(CommunicationProtocols)

The protocol used by the point of sale device.

Value"HTTP"
Example: "HTTP"
communicationEndpointstring or null(CommunicationEndpoint)

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"
statusstring(Status)

The status of the point of sale device.

Enum"New""Pending""Active""Disabled"
Example: "Active"
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/general-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "site": "SITE-1",
    "serialNumber": "SN1234567890",
    "merchantPointOfSaleId": "POS-12345",
    "deviceModel": "CastlesSaturn1000",
    "communicationProtocol": "HTTP",
    "communicationEndpoint": "http://pos.example.com",
    "status": "Active"
  }'

Responses

Successfully updated the general settings.

Log settings

Operations

Store and Forward settings

Operations

URL settings

Operations
©2025 PXP Financial. PXP Financial Registered Office: The Corn Mill - 1 Roydon Road - Stanstead Abbotts - Hertfordshire - SG12 8XL - United Kingdom Phone +44 2038850598. PXP Financial is Authorised By The Financial Conduct Authority And Our Financial Services Register Number is 504318.