Namespace Westpay.Epas
Classes
AdminResponse
The AdminResponse class encapsulates the result of an administrative request
AltMethodTransaction
Contains details of a transaction that was completed using an alternative payment method
BufferTools
This class is used to maintain utility functions to handle buffers.
CardAcceptedEventArgs
Contains details of a card accepted event.
EnableCardReaderOptions
Options for enable card reader
EnableReadersResponse
Encapsulates the details of the response to a request to enable or disable the card readers on the terminal.
EpasClient
The EpasClient class provides the functionality required to operate a Westpay terminal.
LastTransactionResponse
The LastTransactionResponse
LastTransactionResponse.CardData
Card details.
LastTransactionResponse.DccData
The DCC class instance is included if Direct Currency Conversion was selected by the cardholder for the transaction.
LastTransactionResponse.EmvData
The EmvData class instance is included if the card used involved EMV data.
LastTransactionResponse.MerchantData
Merchant details, taken from terminal configuration data. The ECR may have more precise merchent details that can be used instead.
LastTransactionResponse.TransactionData
The TransactionData class contains data elements describing the transaction.
LoginResponse
The LoginResponse class encapsulates the result of a login request
LogoutResponse
The LogoutResponse class encapsulates the result of a logout request
OperatingParameters
Parameters related to terminal operations and transactions.
PurchaseRequest
Parameters that are specific to purchases.
PurchaseTransactionAmounts
Encapsulates the amounts involved in a purchase transaction
ReceiptData
Container class for all the data required to print a receipt
ReceiptData.AuthorisationData
Data relating to the authorisation part of the transaction
ReceiptData.CardData
Card details
ReceiptData.DccData
The DCC class instance is included if Direct Currency Conversion was selected by the cardholder for the transaction.
ReceiptData.EmvData
The EmvData class instance is included if the card used involved EMV data.
ReceiptData.MerchantData
Contains details of the merchant. These are taken from the terminal’s configuration data, and it is reasonable for the ECR to ignore these values and use merchant details that are configured directly in the ECR.
ReceiptData.TransactionData
The TransactionData class contains data elements describing the transaction
RefundRequest
Parameters that are specific to refunds.
SimpleResponse
Base class for responses that will be sent back on the API
TerminalEnvironment
Encapsulates terminal's operating environment and major parameters
TerminalNetworkConnection
Encapsulates all that is needed to create a network connection to a terminal
TransactionRequest
Parameters that are common to all types of transactions.
TransactionResponse
The TransactionResponse class encapsulates the result of a purchase, refund or cash advance request
Interfaces
IClientApp
Interface definition for an app that uses the EPAS Client Library
Enums
AdminOperation
Administrative operations
ApiResult
Statuses related to the API usage. These do not reflect the outcome of transactions, only issues relating to API usage and communications.
AuthorisationChannel
Authorisation method that was used
AuthorisingEntity
Authorising entities
CurrencyCodes
ISO 4217 currency codes
EntryMethod
Enumeration of different possible card presentation methods
ErrorConditions
Condition that has produced an error on the processing of a message request
LogLevel
Logging levels. A production build of the client library will not issue debug level logging.
ReceiptData.TranslatedTextId
The terminal will provide receipt texts that are translated to the customer's chosen language. These texts are referenced by the following IDs
ReceiptVersion
Indicates the intended recipient of a receipt
ServiceEnableType
Transaction type enum use for select transaction type in Enable card reader function
TransactionOutcome
Indicates the result of a transaction
TransactionType
Transaction types
VerificationMethod
Cardholder verification methods
Delegates
EpasClient.CardAcceptedNotification
Delegate definition for card acceptance notifications
EpasClient.CardActionNotification
Delegate definition for card insertion and removal notifications
EpasClient.EpasMessageReceiver
Delegate definition for a raw EPAS XML message handler
EpasClient.StatusNotification
Delegate definition for status notifications