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.