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

Log settings

Operations

Create log settings

Request

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

verboseLoggingEnabledboolean or null

Indicates whether verbose logging is enabled for the point of sale device. When enabled, more detailed logs are generated, which can be useful for debugging and troubleshooting.

Example: true
maximumLogSizeinteger or null(int32)

The maximum size of the log file in bytes. Once the log file reaches this size, older log entries may be removed or archived to prevent exceeding the size limit.

Example: 10485760
logFileCleanUpDaysinteger or null(int32)

The number of days after which log files are cleaned up or archived. This helps manage storage by removing or archiving logs that are older than the specified number of days.

Example: 30
curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/log-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "verboseLoggingEnabled": true,
    "maximumLogSize": 10485760,
    "logFileCleanUpDays": 30
  }'

Responses

Successfully created the log settings.

Get log settings

Request

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

Responses

Successfully retrieved the log settings.

Bodyapplication/json
verboseLoggingEnabledboolean

Indicates whether verbose logging is enabled for the point of sale device. When enabled, more detailed logs are generated, which can be useful for debugging and troubleshooting.

Example: true
maximumLogSizeinteger(int32)

The maximum size of the log file in bytes. Once the log file reaches this size, older log entries may be removed or archived to prevent exceeding the size limit.

Example: 10485760
logFileCleanUpDaysinteger(int32)

The number of days after which log files are cleaned up or archived. This helps manage storage by removing or archiving logs that are older than the specified number of days.

Example: 30
Response
application/json
{
  "verboseLoggingEnabled": true,
  "maximumLogSize": 10485760,
  "logFileCleanUpDays": 30
}

Update log settings

Request

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

verboseLoggingEnabledboolean or null

Indicates whether verbose logging is enabled for the point of sale device. When enabled, more detailed logs are generated, which can be useful for debugging and troubleshooting.

Example: true
maximumLogSizeinteger or null(int32)

The maximum size of the log file in bytes. Once the log file reaches this size, older log entries may be removed or archived to prevent exceeding the size limit.

Example: 10485760
logFileCleanUpDaysinteger or null(int32)

The number of days after which log files are cleaned up or archived. This helps manage storage by removing or archiving logs that are older than the specified number of days.

Example: 30
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/log-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "verboseLoggingEnabled": true,
    "maximumLogSize": 10485760,
    "logFileCleanUpDays": 30
  }'

Responses

Successfully updated the log settings.

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.