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

Store and Forward settings

Operations

URL settings

Operations

Create host URL settings

Request

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

urlstring or null
Example: "https://transaction.example.com"
urlTypestring(HostUrlTypes)

The type of URL.

Enum"Transaction""StoreAndForward""InStoreNotification""DCC"
Example: "Transaction"
curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/host-url-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://transaction.example.com",
    "urlType": "Transaction"
  }'

Responses

Successfully created the host URL settings.

Get host URL settings

Request

This endpoint retrieves specific host URL settings for a point of sale device by URL type.

Path
pointOfSaleIdinteger(int64)required

The unique system identifier for the point of sale device.

Example: 123465789
urlTypestring(HostUrlTypes)required

The type of URL (e.g., Transaction, StoreAndForward, InStoreNotification).

Enum"Transaction""StoreAndForward""InStoreNotification""DCC"
Example: Transaction
curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/123465789/Transaction/host-url-settings

Responses

Successfully retrieved the host URL settings.

Bodyapplication/json
urlstring or null
Example: "https://transaction.example.com"
urlTypestring(HostUrlTypes)

The type of URL.

Enum"Transaction""StoreAndForward""InStoreNotification""DCC"
Example: "Transaction"
Response
application/json
{
  "url": "https://transaction.example.com",
  "urlType": "Transaction"
}

Update host URL settings

Request

This endpoint updates specific host URL settings for a point of sale device by URL type.

Path
pointOfSaleIdinteger(int64)required

The unique system identifier for the point of sale device.

Example: 123456789
urlTypestring(HostUrlTypes)required

The type of URL (e.g., Transaction, StoreAndForward, InStoreNotification).

Enum"Transaction""StoreAndForward""InStoreNotification""DCC"
Example: Transaction
Bodyapplication/jsonrequired

The updated host URL settings.

urlstring or null
Example: "https://transaction.example.com"
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/Transaction/host-url-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://transaction.example.com"
  }'

Responses

Successfully updated the host URL settings.

©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.