Skip to content
/
Store and Forward setting...

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

Create Store and Forward settings

Request

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

storeAndForwardEnabledboolean or null

Specifies whether the store and forward feature should be enabled for the point of sale device. This feature allows transactions to be temporarily stored locally when there is no network connectivity and then forwarded to the server once connectivity is restored.

Example: true
transactionAmountThresholdinteger or null(int32)

Defines the maximum transaction amount (in the smallest currency unit, such as cents) that can be processed using the store and forward feature. Transactions that exceed this threshold will not be stored for later forwarding.

Example: 10000
throttlingLimitinteger or null(int32)

Sets the maximum number of transactions that can be processed within a specific time frame when the store and forward feature is enabled. This helps to manage the flow of transactions once network connectivity is restored.

Example: 100
processIntervalinteger or null(int32)

Specifies the time interval (in seconds) between attempts to process and forward stored transactions once network connectivity is available.

Example: 300
x509PrivateKeystring or null

The private key used for encrypting stored transaction data. This key is part of the X.509 certificate standard, which is used to ensure secure communications.

Example: "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC..."
x509PublicKeystring or null

The public key associated with the private key, used in conjunction with the X.509 certificate for encryption and secure communication.

Example: "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE..."
keyGeneratedstring or null(date-time)

The date and time when the encryption keys were generated, formatted according to the ISO 8601 standard.

Example: "2023-09-01T12:00:00Z"
curl -i -X POST \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/store-and-forward-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "storeAndForwardEnabled": true,
    "transactionAmountThreshold": 10000,
    "throttlingLimit": 100,
    "processInterval": 300,
    "x509PrivateKey": "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC...",
    "x509PublicKey": "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE...",
    "keyGenerated": "2023-09-01T12:00:00Z"
  }'

Responses

Successfully created the store and forward settings.

Get Store and Forward settings

Request

This endpoint retrieves the store and forward 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/store-and-forward-settings

Responses

Successfully retrieved the store and forward settings.

Bodyapplication/json
storeAndForwardEnabledboolean

Indicates whether the store and forward feature is enabled for the point of sale device. This feature allows transactions to be temporarily stored locally when there is no network connectivity and forwarded to the server once connectivity is restored.

Example: true
transactionAmountThresholdinteger(int32)

Specifies the maximum transaction amount (in the smallest currency unit, such as cents) that can be processed using the store and forward feature. Transactions exceeding this amount will not be stored for later forwarding.

Example: 10000
throttlingLimitinteger(int32)

Defines the maximum number of transactions that can be processed in a given time frame when the store and forward feature is enabled. This helps to manage the flow of transactions when connectivity is restored.

Example: 100
processIntervalinteger(int32)

Indicates the interval (in seconds) between attempts to process and forward stored transactions once network connectivity is available.

Example: 300
x509PrivateKeystring or null

The private key used for encryption of stored transaction data. This key is part of the X.509 certificate standard used for secure communications.

Example: "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC..."
x509PublicKeystring or null

The public key associated with the private key, used in the X.509 certificate for encryption and secure communication.

Example: "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE..."
keyGeneratedstring(date-time)

The date and time when the encryption keys were generated, formatted in ISO 8601.

Example: "2023-09-01T12:00:00Z"
Response
application/json
{
  "storeAndForwardEnabled": true,
  "transactionAmountThreshold": 10000,
  "throttlingLimit": 100,
  "processInterval": 300,
  "x509PrivateKey": "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC...",
  "x509PublicKey": "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE...",
  "keyGenerated": "2023-09-01T12:00:00Z"
}

Update Store and Forward settings

Request

This endpoint updates the store and forward 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 store and forward settings.

storeAndForwardEnabledboolean or null

Specifies whether the store and forward feature should remain enabled or be disabled for the point of sale device. This feature allows transactions to be stored locally when there is no network connectivity and then forwarded to the server once connectivity is restored.

Example: true
transactionAmountThresholdinteger or null(int32)

Defines the maximum transaction amount (in the smallest currency unit, such as cents) that can be processed using the store and forward feature. Transactions exceeding this amount will not be stored for later forwarding.

Example: 10000
throttlingLimitinteger or null(int32)

Sets the maximum number of transactions that can be processed within a specific time frame when the store and forward feature is enabled. This helps to control the flow of transactions once network connectivity is restored.

Example: 100
processIntervalinteger or null(int32)

Specifies the time interval (in seconds) between attempts to process and forward stored transactions once network connectivity is available.

Example: 300
x509PrivateKeystring or null

The private key used for encrypting stored transaction data. This key is part of the X.509 certificate standard, which is used to ensure secure communications.

Example: "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC..."
x509PublicKeystring or null

The public key associated with the private key, used in conjunction with the X.509 certificate for encryption and secure communication.

Example: "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE..."
keyGeneratedstring or null(date-time)

The date and time when the encryption keys were generated, formatted according to the ISO 8601 standard.

Example: "2023-09-01T12:00:00Z"
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/store-and-forward-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "storeAndForwardEnabled": true,
    "transactionAmountThreshold": 10000,
    "throttlingLimit": 100,
    "processInterval": 300,
    "x509PrivateKey": "MIIBVgIBADANBgkqhkiG9w0BAQEFAASC...",
    "x509PublicKey": "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE...",
    "keyGenerated": "2023-09-01T12:00:00Z"
  }'

Responses

Successfully updated the store and forward settings.

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.