Class OperatingParameters

Parameters related to terminal operations and transactions.

Inheritance

System.Object

OperatingParameters

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Westpay.Epas

Assembly: EpasClientLibrary.dll

Syntax

public class OperatingParameters

Properties

EnableTip

Indicates if tipping is enabled in purchase transactions.

Declaration

public bool EnableTip { get; set; }

Property Value

Type	Description
System.Boolean	true if tipping should be enabled, false if it should be disabled. The default is false.

Remarks

The ECR can set this to true to enable tipping or false to disable tipping. Tipping only applies to purchase transactions.

Note that tipping functionality must also be enabled in the terminal configuration before it will be active. This setting is more useful to disable tipping when it is enabled in configuration.

LogXmlMessages

Set this to true to make the library log EPAS XML messages with the ECR.

Declaration

public bool LogXmlMessages { get; set; }

Property Value

Type	Description
System.Boolean	Set to true to make the library log EPAS messages.

Remarks

If set to true, the this property causes the incoming and outgoing XML messages that make up the EPAS protocol to be logged with the ECR at debug level.

StorageDirectory

Defines a directory where log data from the terminal can be stored, and which will be used for temporary files in some situations. My be fully accessible to the client library. The user's temporary folder is the default for this.

Declaration

public string StorageDirectory { get; set; }

Property Value

Type	Description
System.String	A path to a directory.

TransactionCurrency

Defines the currency to be used in transactions. This must match the currency that is configured in the terminal.

Declaration

public CurrencyCodes TransactionCurrency { get; set; }

Property Value

Type	Description
CurrencyCodes	The currency. The default is SEK

Remarks

This property defines the currency that will be specified in EPAS messaging. In normal use this must match the currency that is configured in the terminal.

It is possible, however, for the terminal to be configured to accept transactions in different currencies, in which case the transaction currency here must be one of those that are configured.

WaitForCardRemoval

Controls whether the terminal should wait for a chip card to be taken before reporting the transaction result.

Declaration

public bool WaitForCardRemoval { get; set; }

Property Value

Type	Description
System.Boolean	true if the terminal should wait for the card to be removed. The default is false.

Remarks

This property controls whether the terminal will wait for an inserted chip card to be removed before it sends the transaction response back, or if it sends the response before the card is taken.

Setting this to false can make the transaction feel faster, since the result is available sooner. But setting this to true makes it less likely that the customer will leave their card in the terminal by mistake.

Regardless of this setting the terminal will not allow a new transaction until the card has been taken.