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

Create feature settings

Request

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

merchantPointOfSaleIdstring or null

The unique merchant identifier for the point of sale device.

Example: "POS-12345"
statusPacketsEnabledboolean or null

Indicates whether status packets, which provide real-time updates about the device's status, are enabled for the point of sale device.

Example: true
languageSelectionEnabledboolean or null

Specifies whether the language selection feature is enabled, allowing users to choose their preferred language during transactions.

Example: true
gratuityEnabledboolean or null

Indicates whether the gratuity (tip) feature is enabled, allowing customers to add a tip to their transactions.

Example: false
onlinePinEnabledboolean or null

Specifies whether the online PIN feature is enabled, requiring customers to enter their PIN for card transactions.

Example: true
keyedEnabledboolean or null

Indicates whether the keyed entry feature is enabled, allowing manual entry of card details for transactions.

Example: false
curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/feature-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "merchantPointOfSaleId": "POS-12345",
    "statusPacketsEnabled": true,
    "languageSelectionEnabled": true,
    "gratuityEnabled": false,
    "onlinePinEnabled": true,
    "keyedEnabled": false
  }'

Responses

Successfully created the feature settings.

Get feature settings

Request

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

Responses

Successfully retrieved the feature settings.

Bodyapplication/json
merchantPointOfSaleIdstring

The unique merchant identifier for the point of sale device.

Example: "POS-12345"
statusPacketsEnabledboolean

Indicates whether status packets, which provide real-time updates about the device's status, are enabled for the point of sale device.

languageSelectionEnabledboolean

Specifies whether the language selection feature is enabled, allowing users to choose their preferred language during transactions.

gratuityEnabledboolean

Indicates whether the gratuity (tip) feature is enabled, allowing customers to add a tip to their transactions.

onlinePinEnabledboolean

Specifies whether the online PIN feature is enabled, requiring customers to enter their PIN for card transactions.

keyedEnabledboolean

Indicates whether the keyed entry feature is enabled, allowing manual entry of card details for transactions.

Response
application/json
{
  "merchantPointOfSaleId": "POS-12345",
  "statusPacketsEnabled": true,
  "languageSelectionEnabled": true,
  "gratuityEnabled": true,
  "onlinePinEnabled": true,
  "keyedEnabled": true
}

Update feature settings

Request

This endpoint updates the feature 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 feature settings.

merchantPointOfSaleIdstring or null

The unique merchant identifier for the point of sale device.

Example: "POS-12345"
statusPacketsEnabledboolean or null

Indicates whether status packets, which provide real-time updates about the device's status, are enabled for the point of sale device.

Example: true
languageSelectionEnabledboolean or null

Specifies whether the language selection feature is enabled, allowing users to choose their preferred language during transactions.

Example: true
gratuityEnabledboolean or null

Indicates whether the gratuity (tip) feature is enabled, allowing customers to add a tip to their transactions.

Example: false
onlinePinEnabledboolean or null

Specifies whether the online PIN feature is enabled, requiring customers to enter their PIN for card transactions.

Example: true
keyedEnabledboolean or null

Indicates whether the keyed entry feature is enabled, allowing manual entry of card details for transactions.

Example: false
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/feature-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "merchantPointOfSaleId": "POS-12345",
    "statusPacketsEnabled": true,
    "languageSelectionEnabled": true,
    "gratuityEnabled": false,
    "onlinePinEnabled": true,
    "keyedEnabled": false
  }'

Responses

Successfully updated the feature settings.

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.