Skip to content
/Authentication 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

Create authentication settings

Request

This endpoint creates authentication 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 authentication settings to apply to the point of sale device.

hmacKeystringrequired

The single hmac key used in association with the point of sale device to authenticate.

Example: "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/authentication-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "hmacKey": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
  }'

Responses

Successfully created the authentication settings.

Get authentication settings

Request

This endpoint retrieves the authentication 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/authentication-settings

Responses

Successfully retrieved the authentication settings.

Bodyapplication/json
hmacKeystring or null
Example: "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
Response
application/json
{
  "hmacKey": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
}

Update authentication settings

Request

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

Path
pointOfSaleIdinteger(int64)required

The unique system identifier for the point of sale device.

Example: 12345789
Bodyapplication/jsonrequired

The updated authentication settings.

hmacKeystring or null
Example: "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/12345789/authentication-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "hmacKey": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
  }'

Responses

Successfully updated the authentication settings.

Feature settings

Operations

General settings

Operations

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.