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

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