Class Terminal
Inheritance
Implements
Inherited Members
Namespace: SIX.TimApi
Assembly: TimApi.dll
Syntax
public class Terminal : IDisposable
Constructors
Terminal(TerminalSettings)
Declaration
public Terminal(TerminalSettings settings)
Parameters
Type | Name | Description |
---|---|---|
TerminalSettings | settings |
Fields
CLASS_NAME
Declaration
public static string CLASS_NAME
Field Value
Type | Description |
---|---|
System.String |
LOGGER_NAME
Declaration
public static string LOGGER_NAME
Field Value
Type | Description |
---|---|
System.String |
m_AsyncOp
Declaration
protected AsyncOperation m_AsyncOp
Field Value
Type | Description |
---|---|
System.ComponentModel.AsyncOperation |
m_AsyncOpStatus
Declaration
protected readonly AsyncOperation m_AsyncOpStatus
Field Value
Type | Description |
---|---|
System.ComponentModel.AsyncOperation |
UseAsyncOperationInSyncContext
Declaration
public bool UseAsyncOperationInSyncContext
Field Value
Type | Description |
---|---|
System.Boolean |
Properties
ActSeqCounter
Gets the Activation sequence counter.
Declaration
public int ActSeqCounter { get; }
Property Value
Type | Description |
---|---|
System.Int32 | The act seq counter. |
Brands
Gets the brands or null if not retrieved yet.
Declaration
public List<Brand> Brands { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Brand> | The brands. |
ConfigData
Declaration
public ConfigData ConfigData { get; }
Property Value
Type | Description |
---|---|
ConfigData |
CustomerData
Declaration
public Dictionary<CustomerDataType, string> CustomerData { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<CustomerDataType, System.String> |
EcrData
Gets or sets the ecr data.
Declaration
public List<EcrInfo> EcrData { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<EcrInfo> | The ecr data. |
Features
Gets the features or if not retrieved yet.
Declaration
public Features Features { get; }
Property Value
Type | Description |
---|---|
Features | The features. |
IntegratorId
Gets or sets the integrator identifier.
Declaration
public string IntegratorId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The integrator identifier. |
ManufacturerFlags
Gets or sets the manufacturer flags.
Declaration
public int ManufacturerFlags { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The manufacturer flags. |
MerchantOptions
Declaration
public List<MerchantOption> MerchantOptions { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<MerchantOption> |
PosId
Gets or sets the pos identifier.
Declaration
public string PosId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The pos identifier. |
PrintOptions
Gets or sets the print options for merchant and customer.
Declaration
public PrintOptionList PrintOptions { get; set; }
Property Value
Type | Description |
---|---|
PrintOptionList | The print options. |
ReceiptFormatter
Gets or sets the receipt formatter.
Declaration
public ReceiptFormatter ReceiptFormatter { get; set; }
Property Value
Type | Description |
---|---|
ReceiptFormatter | The receipt formatter. |
RunningRequest
Declaration
protected RequestTypes RunningRequest { get; set; }
Property Value
Type | Description |
---|---|
RequestTypes |
RunningSyncRequest
Declaration
protected RequestTypes RunningSyncRequest { get; set; }
Property Value
Type | Description |
---|---|
RequestTypes |
Settings
Gets the terminal settings.
Declaration
public ImmutableTerminalSettings Settings { get; }
Property Value
Type | Description |
---|---|
ImmutableTerminalSettings | The settings. |
TerminalId
Declaration
public string TerminalId { get; }
Property Value
Type | Description |
---|---|
System.String |
TerminalStatus
Gets the terminal status.
Declaration
public TerminalStatus TerminalStatus { get; }
Property Value
Type | Description |
---|---|
TerminalStatus | The terminal status. |
TimApiVersion
Tim Api Build Version.
Declaration
public static string TimApiVersion { get; }
Property Value
Type | Description |
---|---|
System.String | The tim API version. |
TransactionData
Gets or sets the transaction data.
Declaration
public TransactionData TransactionData { get; set; }
Property Value
Type | Description |
---|---|
TransactionData | The transaction data. |
UserId
Gets or sets the user identifier.
Declaration
public int UserId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The user identifier. |
Methods
Activate()
Activates the terminal.
Declaration
public ActivateResponse Activate()
Returns
Type | Description |
---|---|
ActivateResponse | the ActivateResponse |
Exceptions
Type | Condition |
---|---|
TimException | an error occured during the activation |
ActivateAsync()
Activates the terminal asychronous.
Declaration
public void ActivateAsync()
Remarks
This method starts an activation on the terminal.
This method does not block the calling thread during the activation and uses the Event-based Asynchronous Pattern (EAP).
When the transaction completes, the ActivateCompleted event is raised.
Your application must handle this event to receive notification.
The response is available in the Terminal.ActivateCompletedEventArgs as ActivateResponse
ActivateServiceMenu()
Activates the service menu to the terminal.
Declaration
public void ActivateServiceMenu()
Remarks
requests on its own, without interaction with the ECR. The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the TerminalStatus notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
Note: This method is only available if Guides UNATTENDED is enabled.ActivateServiceMenuAsync()
Asynchronously activates the service menu on the terminal
Declaration
public void ActivateServiceMenuAsync()
Remarks
activates the service menu on the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the TerminalStatus notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
ActivateServiceMenuCompleted event is raised on completion.AddEcrData(EcrInfo)
Add ECR data replacing existing one if present. To remove elements use setEcrData instead.
Declaration
public void AddEcrData(EcrInfo ecrInfo)
Parameters
Type | Name | Description |
---|---|---|
EcrInfo | ecrInfo | The ecr information. |
AmtAdjustment(Amount)
Dynamically adjusts the transaction amount of an already running transaction.
Declaration
public void AmtAdjustment(Amount amount)
Parameters
Type | Name | Description |
---|---|---|
Amount | amount |
Remarks
This is a "best effort" function and will be processed as long as the underlying payment protocol supports it. The amount transmitted in the notification is the new total amount. The EFT does not calculate amounts, this is the ECRs responsibility.
Note: This method is only available if {@link com.six.timapi.constants.Guides#UNATTENDED} is enabled.
AmtAdjustment(Amount, AmountDiscount, List<LoyaltyCoupon>, List<LoyaltyInformation>)
Dynamically adjusts the transaction amount of an already running transaction.
Declaration
public void AmtAdjustment(Amount amount, AmountDiscount amountDiscount, List<LoyaltyCoupon> loyaltyCouponList, List<LoyaltyInformation> loyaltyInformationList)
Parameters
Type | Name | Description |
---|---|---|
Amount | amount | |
AmountDiscount | amountDiscount | |
System.Collections.Generic.List<LoyaltyCoupon> | loyaltyCouponList | |
System.Collections.Generic.List<LoyaltyInformation> | loyaltyInformationList |
Remarks
This is a "best effort" function and will be processed as long as the underlying payment protocol supports it. The amount transmitted in the notification is the new total amount. The EFT does not calculate amounts, this is the ECRs responsibility.
Note: This method is only available if {@link com.six.timapi.constants.Guides#UNATTENDED} is enabled.
ApplicationInformation()
Requests the list of brands available on the terminal.
Declaration
public void ApplicationInformation()
Remarks
Side-Effect: Updates Brands member with all brands available on the terminal. Use {@link Terminal#getBrands} to retrieve them.
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the applicationInformation |
ApplicationInformationAsync()
Requests the list of brands available on the terminal asychronously.
Declaration
public void ApplicationInformationAsync()
Remarks
Side-Effect: Updates Brands member with all brands available on the terminal. Use Brands to retrieve them.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ApplicationInformationCompleted event is raised. Your application must handle this event to receive notification.
Balance()
Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing.
Declaration
public BalanceResponse Balance()
Returns
Type | Description |
---|---|
BalanceResponse | the BalanceResponse |
Exceptions
Type | Condition |
---|---|
TimException | An error occurred during the balance. |
BalanceAsync()
Asyncronously forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing.
Declaration
public void BalanceAsync()
Remarks
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the BalanceCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.BalanceCompletedEventArgs as BalanceResponse event is raised. Your application must handle this event to receive notification.
BalanceInquiry()
Get information about the current account balance of the inserted card.
Declaration
public BalanceInquiryResponse BalanceInquiry()
Returns
Type | Description |
---|---|
BalanceInquiryResponse |
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#ADVANCED_RETAIL} is enabled.
BalanceInquiryAsync()
Get information about the current account balance of the inserted card.
Declaration
public void BalanceInquiryAsync()
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#ADVANCED_RETAIL} is enabled. This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the BalanceInquiryCompleted event is raised. Your application must handle this event to receive notification.
Cancel()
Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a Commit() or RollbackAsync() request, which cannot be canceled.
Declaration
public void Cancel()
Remarks
Further information:
A Cancel-request is a best effort request. The EFT Terminal can ignore the Cancel-request if the request in progress is in a state it can not be canceled. A Cancel-request has no effect if there's no open request of a Financial Transaction or Non-financial Transaction. If the EFT Terminal cancels the request in progress an error response is send back for the canceled request (see chapter Abort Purchase for an example). Cancel-requests can be send multiple times in an attempt to cancel a request in progress but should be spaced by a few seconds. Cancel-requests themselves are never acknowledged by the EFT Terminal.
The Transaction request can only be canceled before a Commit has been performed. Also the underlying payment protocol can restrict this functionality.
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Cancel |
Cancel(Boolean, Boolean)
Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a Commit() or RollbackAsync() request, which cannot be canceled.
Declaration
public void Cancel(bool silent, bool retainCard)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | silent | |
System.Boolean | retainCard |
Remarks
Further information:
A Cancel-request is a best effort request. The EFT Terminal can ignore the Cancel-request if the request in progress is in a state it can not be canceled. A Cancel-request has no effect if there's no open request of a Financial Transaction or Non-financial Transaction. If the EFT Terminal cancels the request in progress an error response is send back for the canceled request (see chapter Abort Purchase for an example). Cancel-requests can be send multiple times in an attempt to cancel a request in progress but should be spaced by a few seconds. Cancel-requests themselves are never acknowledged by the EFT Terminal.
The Transaction request can only be canceled before a Commit has been performed. Also the underlying payment protocol can restrict this functionality.
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Cancel |
ChangeSettings(List<Setting>)
Changes configuration parameters of the EFT Terminal.
List of settings to change.Declaration
public void ChangeSettings(List<Setting> settings)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<Setting> | settings |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during ChangeSettings |
ChangeSettingsAsync(List<Setting>)
Changes configuration parameters of the EFT Terminal asynchronously.
Declaration
public void ChangeSettingsAsync(List<Setting> settings)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<Setting> | settings | List of settings to change. |
Remarks
This method does not block the calling thread during the change settings operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ChangeSettingsCompleted event is raised. Your application must handle this event to receive notification.
CloseDialogMode()
Close dialog mode on the terminal.
Declaration
public void CloseDialogMode()
Remarks
Note: This method is only available if Guides DIALOG is enabled.
CloseDialogModeAsync()
CLose dialog mode on the terminal.
Declaration
public void CloseDialogModeAsync()
Remarks
Note: This method is only available if Guides DIALOGis enabled. This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the CloseDialogModeCompleted event is raised. Your application must handle this event to receive notification.
CloseMaintenanceWindow()
Closes the maintenance window to the terminal.
Declaration
public void CloseMaintenanceWindow()
Remarks
requests on its own, without interaction with the ECR. The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the TerminalStatus notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
Note: This method is only available if Guides UNATTENDED is enabled.CloseMaintenanceWindowAsync()
Asynchronously opens the maintenance window to the terminal so it can perform collected maintenance.
Declaration
public void CloseMaintenanceWindowAsync()
Remarks
requests on its own, without interaction with the ECR. The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the TerminalStatus notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
OpenMaintenanceWindowCompleted event is raised on completion. Note: This method is only available if Guides UNATTENDED is enabled.CloseReader()
Close the shutter of the card reader.
Declaration
public void CloseReader()
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#UNATTENDED} is enabled.
CloseReaderAsync()
Open the shutter of the card reader asynchronously.
Declaration
public void CloseReaderAsync()
Remarks
Note: This method is only available if Guides UNATTENDED is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the operation completes, the CloseReaderCompleted event is raised. Your application must handle this event to receive notification.
CommandCompleted()
Declaration
protected void CommandCompleted()
Commit()
Performs Commit-operation after a successful Transaction call.
Declaration
public void Commit()
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Commit |
Commit(Amount)
Performs Commit-operation after a successful Transaction call with an amount lower than in the transaction.
Declaration
public PrintData Commit(Amount amount)
Parameters
Type | Name | Description |
---|---|---|
Amount | amount |
Returns
Type | Description |
---|---|
PrintData |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Commit |
CommitAsync()
Performs an asynchronous Commit-operation after a successful Transaction call .
Declaration
public void CommitAsync()
Remarks
This method does not block the calling thread during the commit operation and uses the Event-based Asynchronous Pattern (EAP). When the commit completes, the CommitCompleted event is raised. Your application must handle this event to receive notification.
CommitAsync(Amount)
Performs an asynchronous Commit-operation after a successful Transaction call with an amount lower than in the transaction.
Declaration
public void CommitAsync(Amount amount)
Parameters
Type | Name | Description |
---|---|---|
Amount | amount |
Remarks
This method does not block the calling thread during the commit operation and uses the Event-based Asynchronous Pattern (EAP). When the commit completes, the CommitCompleted event is raised. Your application must handle this event to receive notification.
Connect()
Initiates a connection to the EFT Terminal.
Declaration
public void Connect()
Remarks
Calling the Connect() is not needed normally, because all methods make first a connect, if not connected.
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Cancel |
ConnectAsync()
Initiates a connection to the EFT Terminal.
Declaration
public void ConnectAsync()
Remarks
Calling the Connect() is not needed normally, because all methods make first a connect, if not connected.
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Cancel |
CounterRequest(CounterType)
Get counter information's from the EFT Terminal.
Declaration
public CounterList CounterRequest(CounterType type)
Parameters
Type | Name | Description |
---|---|---|
CounterType | type | type of counters to request. |
Returns
Type | Description |
---|---|
CounterList | the CounterList |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the CounterRequest |
CounterRequestAsync(CounterType)
Get counter informations from the EFT Terminal asynchronously.
Declaration
public void CounterRequestAsync(CounterType type)
Parameters
Type | Name | Description |
---|---|---|
CounterType | type |
Remarks
This method does not block the calling thread during the CounterRequest and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the CounterRequestCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.CounterRequestCompletedEventArgs as CounterList.
DccRates()
Requests DCC rates from the EFT Terminal. The DCC rates are returned as receipt.
Declaration
public PrintData DccRates()
Returns
Type | Description |
---|---|
PrintData | the PrintData |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the DccRates operation |
DccRatesAsync()
Requests DCC rates from the EFT Terminal asynchronously. The DCC rates are returned as receipt.
Declaration
public void DccRatesAsync()
Remarks
This method does not block the calling thread during the DccRates operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the DccRatesCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.DccRatesCompletedEventArgs as PrintData.
Deactivate()
Closes a user shift.
Declaration
public DeactivateResponse Deactivate()
Returns
Type | Description |
---|---|
DeactivateResponse | the DeactivateResponse |
Remarks
If the shift is already closed, no error is returned.
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the deactivation |
DeactivateAsync()
Deactivates the terminal asynchronous.
Declaration
public void DeactivateAsync()
Remarks
This method starts a deactivation on the terminal.
This method does not block the calling thread during the activation and uses the Event-based Asynchronous Pattern (EAP).
When the transaction completes, the DeactivateCompleted event is raised.
Your application must handle this event to receive notification.
The response is available in the Terminal.DeactivateCompletedEventArgs as DeactivateResponse.
Disconnect()
Interrupts the connection to the EFT Terminal.
Declaration
public void Disconnect()
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the disconnect |
DisconnectAsync()
Interrupts the connection to the EFT Terminal.
Declaration
public void DisconnectAsync()
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the disconnect |
Dispose()
Dispose of terminal.
Declaration
public void Dispose()
EjectCard()
Eject a card from the card reader.
Declaration
public void EjectCard()
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#UNATTENDED} is enabled.
EjectCardAsync()
Eject a card from the card reader asynchronously.
Declaration
public void EjectCardAsync()
Remarks
Note: This method is only available if Guides UNATTENDED is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the operation completes, the EjectCardCompleted event is raised. Your application must handle this event to receive notification.
FinishCheckout()
Finish checkout process.
Declaration
public VasCheckoutInformation FinishCheckout()
Returns
Type | Description |
---|---|
VasCheckoutInformation |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
FinishCheckoutAsync()
Finish checkout process.
Declaration
public void FinishCheckoutAsync()
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the FinishCheckoutCompleted event is raised. Your application must handle this event to receive notification.
HardwareInformation()
Get hardware information from the EFT Terminal.
Declaration
public HardwareInformationResponse HardwareInformation()
Returns
Type | Description |
---|---|
HardwareInformationResponse |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the HardwareInformation operation |
HardwareInformationAsync()
Get hardware information from the EFT Terminal asynchronously.
Declaration
public void HardwareInformationAsync()
Remarks
This method does not block the calling thread during the HardwareInformation operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the HardwareInformationCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.HardwareInformationCompletedEventArgs as HardwareInformationResponse.
HoldCommit()
Extends the Commit timeout if the terminal needs additional time before the Commit
Declaration
public void HoldCommit()
InitTransaction(Boolean, Amount)
Initialize a transaction knowing the amount or the card type.
Declaration
public CardData InitTransaction(bool displayAmount, Amount amount)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | displayAmount | |
Amount | amount |
Returns
Type | Description |
---|---|
CardData |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the InitTransaction operation |
InitTransaction(Boolean, Amount, FunctionHint)
Declaration
public CardData InitTransaction(bool displayAmount, Amount amount, FunctionHint functionHint)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | displayAmount | |
Amount | amount | |
FunctionHint | functionHint |
Returns
Type | Description |
---|---|
CardData |
InitTransactionAsync(Boolean, Amount)
Initialize a transaction asynchronously, knowing the amount or the card type .
Declaration
public void InitTransactionAsync(bool displayAmount, Amount amount)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | displayAmount | |
Amount | amount |
Remarks
This method does not block the calling thread during the InitTransaction operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the InitTransactionCompleted event is raised. Your application must handle this event to receive notification.
InitTransactionAsync(Boolean, Amount, FunctionHint)
Declaration
public void InitTransactionAsync(bool displayAmount, Amount amount, FunctionHint functionHint)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | displayAmount | |
Amount | amount | |
FunctionHint | functionHint |
Login()
Activate a communication session between the ECR and the terminal.
Declaration
public void Login()
Remarks
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the InitTransaction operation |
LoginAsync()
Activate a communication session between the ECR and the terminal asynchronously.
Declaration
public void LoginAsync()
Remarks
Logout()
Terminates an active communication session between the ECR and the terminal.
Declaration
public void Logout()
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Logout |
LogoutAsync()
Terminates an active communication session between the ECR and the terminal asynchronously.
Declaration
public void LogoutAsync()
Remarks
This method does not block the calling thread during the Logout operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the LogoutCompleted event is raised. Your application must handle this event to receive notification.
LoyaltyData(LoyaltyFunctionType, String, Byte[], Boolean)
Query and configure loyalty information.
Declaration
public CardData LoyaltyData(LoyaltyFunctionType functionType, string dataType, byte[] data, bool retainCard)
Parameters
Type | Name | Description |
---|---|---|
LoyaltyFunctionType | functionType | |
System.String | dataType | |
System.Byte[] | data | |
System.Boolean | retainCard |
Returns
Type | Description |
---|---|
CardData |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
LoyaltyDataAsync(LoyaltyFunctionType, String, Byte[], Boolean)
Query and configure loyalty information.
Declaration
public void LoyaltyDataAsync(LoyaltyFunctionType functionType, string dataType, byte[] data, bool retainCard)
Parameters
Type | Name | Description |
---|---|---|
LoyaltyFunctionType | functionType | |
System.String | dataType | |
System.Byte[] | data | |
System.Boolean | retainCard |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the LoyaltyDataCompleted event is raised. Your application must handle this event to receive notification.
OpenDialogMode()
Open dialog mode on the terminal.
Declaration
public void OpenDialogMode()
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#DIALOG} is enabled.
OpenDialogModeAsync()
Open dialog mode on the terminal.
Declaration
public void OpenDialogModeAsync()
Remarks
Note: This method is only available if Guides DIALOG is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the OpenDialogModeCompleted event is raised. Your application must handle this event to receive notification.
OpenMaintenanceWindow()
Opens the maintenance window on the terminal
Declaration
public void OpenMaintenanceWindow()
Remarks
it can perform collected maintenance requests on its own, without interaction with the ECR. The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the TerminalStatus notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
Note: This method is only available if Guides UNATTENDED is enabled.OpenMaintenanceWindowAsync()
Declaration
public void OpenMaintenanceWindowAsync()
OpenReader()
Open the shutter of the card reader.
Declaration
public void OpenReader()
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#UNATTENDED} is enabled.
OpenReaderAsync()
Open the shutter of the card reader asynchronously.
Declaration
public void OpenReaderAsync()
Remarks
Note: This method is only available if Guides UNATTENDED is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the OpenReaderCompleted event is raised. Your application must handle this event to receive notification.
PrintOnTerminal(String)
The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal. The ticket is then printed on the terminal printer. The ticket must be formatted according [B39].
Declaration
public void PrintOnTerminal(string ticketData)
Parameters
Type | Name | Description |
---|---|---|
System.String | ticketData |
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#DIALOG} is enabled.
PrintOnTerminalAsync(String)
The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal. The ticket is then printed on the terminal printer. The ticket must be formatted according [B39].
Declaration
public void PrintOnTerminalAsync(string ticketData)
Parameters
Type | Name | Description |
---|---|---|
System.String | ticketData |
Remarks
Note: This method is only available if {@link com.six.timapi.constants.Guides#DIALOG} is enabled.
processPrintReceipts(PrintData)
Declaration
protected PrintData processPrintReceipts(PrintData printData)
Parameters
Type | Name | Description |
---|---|---|
PrintData | printData |
Returns
Type | Description |
---|---|
PrintData |
ProvideLoyaltyBasket(List<LoyaltyItem>)
provide the terminal with a LoyaltyBasket.
Declaration
public List<LoyaltyItem> ProvideLoyaltyBasket(List<LoyaltyItem> basket)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<LoyaltyItem> | basket |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<LoyaltyItem> |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
ProvideLoyaltyBasketAsync(List<LoyaltyItem>)
provide the terminal with a LoyaltyBasket.
Declaration
public void ProvideLoyaltyBasketAsync(List<LoyaltyItem> basket)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<LoyaltyItem> | basket |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ProvideLoyaltyBasketCompleted event is raised. Your application must handle this event to receive notification.
ProvideVasResult(VasResult)
Provide VAS result to terminal.
Declaration
public VasResult ProvideVasResult(VasResult result)
Parameters
Type | Name | Description |
---|---|---|
VasResult | result |
Returns
Type | Description |
---|---|
VasResult |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
ProvideVasResultAsync(VasResult)
Provide VAS result to terminal.
Declaration
public void ProvideVasResultAsync(VasResult result)
Parameters
Type | Name | Description |
---|---|---|
VasResult | result |
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ProvideLoyaltyBasketCompleted event is raised. Your application must handle this event to receive notification.
Reboot()
Force the EFT Terminal to reboot.
Declaration
public void Reboot()
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the Reboot |
RebootAsync()
Asynchronously force the EFT Terminal to reboot.
Declaration
public void RebootAsync()
Remarks
This method does not block the calling thread during the reboot operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the RebootCompleted event is raised. Your application must handle this event to receive notification.
ReceiptRequest(ReceiptRequestType)
Receive the latest receipt or a list of silent receipts.
Declaration
public ReceiptRequestResponse ReceiptRequest(ReceiptRequestType ReceiptType)
Parameters
Type | Name | Description |
---|---|---|
ReceiptRequestType | ReceiptType | Type of receipts to request from the EFT Terminal. |
Returns
Type | Description |
---|---|
ReceiptRequestResponse | the ReceiptRequestResponse |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the receipt request |
ReceiptRequestAsync(ReceiptRequestType)
Asynchronously receive the latest receipt or a list of silent receipts.
Declaration
public void ReceiptRequestAsync(ReceiptRequestType ReceiptType)
Parameters
Type | Name | Description |
---|---|---|
ReceiptRequestType | ReceiptType | Type of receipts to request from the EFT Terminal. |
Remarks
This method does not block the calling thread during the receipt request and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ReceiptRequestCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.ReceiptRequestCompletedEventArgs as ReceiptRequestResponse.
Reconciliation()
Force the EFT Terminal to transmit all financial transactions to the host system.
Declaration
public ReconciliationResponse Reconciliation()
Returns
Type | Description |
---|---|
ReconciliationResponse | the ReconciliationResponse |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the reconciliation |
ReconciliationAsync()
Asynchronously forces the EFT Terminal to transmit all financial transactions to the host system..
Declaration
public void ReconciliationAsync()
Remarks
This method does not block the calling thread during the reconciliation operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ReconciliationCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.ReconciliationCompletedEventArgs as ReconciliationResponse.
Reconfig()
Force the EFT Terminal to get the configuration from the service center.
Declaration
public PrintData Reconfig()
Returns
Type | Description |
---|---|
PrintData | the PrintData |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the receipt request |
ReconfigAsync()
Asynchronously force the EFT Terminal to get the configuration from the service center..
Declaration
public void ReconfigAsync()
Remarks
This method does not block the calling thread during the reconfiguration and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ReconfigCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.ReconfigCompletedEventArgs as PrintData.
RequestAlias(String)
The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions
Declaration
public string RequestAlias(string sixTransRef)
Parameters
Type | Name | Description |
---|---|---|
System.String | sixTransRef | The SIX omni channel reference number. |
Returns
Type | Description |
---|---|
System.String | The Alias created by Saferpay. |
Remarks
Saferpay offers these kind of transactions which can be performed only using a secure Alias that can be created out of card information from a precious transaction. This Alias then can be used to perform a transaction without the same card present..
Exceptions
Type | Condition |
---|---|
TimException |
RequestAliasAsync(String)
Declaration
public void RequestAliasAsync(string sixTransRef)
Parameters
Type | Name | Description |
---|---|---|
System.String | sixTransRef |
Rollback()
Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization. For payment protocols supporting the function a declined receipt may be generated.
Declaration
public PrintData Rollback()
Returns
Type | Description |
---|---|
PrintData | the PrintData |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the rollback |
RollbackAsync()
Asynchronously prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization. For payment protocols supporting the function a declined receipt may be generated.
Declaration
public void RollbackAsync()
Remarks
This method does not block the calling thread during the rollback and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the RollbackCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.RollbackCompletedEventArgs as PrintData.
SendCardCommand(List<CommandRequest>)
This function is used for a direct communication with the inserted card using APDUs.
Declaration
public List<CommandResponse> SendCardCommand(List<CommandRequest> requests)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<CommandRequest> | requests |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<CommandResponse> |
Remarks
Note: This method is only available if Guides DIALOG is enabled.
SendCardCommandAsync(List<CommandRequest>)
This function is used for a direct communication with the inserted card using APDUs.
Declaration
public void SendCardCommandAsync(List<CommandRequest> requests)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<CommandRequest> | requests |
Remarks
Note: This method is only available if Guides DIALOG is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the SendCardCommandCompleted event is raised. Your application must handle this event to receive notification.
ShowDialog(ShowDialogRequest)
Show dialog on the terminal.
Declaration
public ShowDialogResponse ShowDialog(ShowDialogRequest request)
Parameters
Type | Name | Description |
---|---|---|
ShowDialogRequest | request |
Returns
Type | Description |
---|---|
ShowDialogResponse |
Remarks
Can be called only if dialog mode is open.
Note: This method is only available if {@link com.six.timapi.constants.Guides#DIALOG} is enabled.ShowDialogAsync(ShowDialogRequest)
Show dialog on the terminal.
Declaration
public void ShowDialogAsync(ShowDialogRequest request)
Parameters
Type | Name | Description |
---|---|---|
ShowDialogRequest | request |
Remarks
Can be called only if dialog mode is open.
Note: This method is only available if Guides DIALOG is enabled.This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ShowDialogCompleted event is raised. Your application must handle this event to receive notification.
ShowSignatureCapture(ShowSignatureCaptureRequest)
Show signature capture on the terminal.
Declaration
public ShowSignatureCaptureResponse ShowSignatureCapture(ShowSignatureCaptureRequest request)
Parameters
Type | Name | Description |
---|---|---|
ShowSignatureCaptureRequest | request |
Returns
Type | Description |
---|---|
ShowSignatureCaptureResponse |
Remarks
Can be called only if dialog mode is open.
Note: This method is only available if {@link com.six.timapi.constants.Guides#DIALOG} is enabled.ShowSignatureCaptureAsync(ShowSignatureCaptureRequest)
Show signature capture on the terminal.
Declaration
public void ShowSignatureCaptureAsync(ShowSignatureCaptureRequest request)
Parameters
Type | Name | Description |
---|---|---|
ShowSignatureCaptureRequest | request |
Remarks
Can be called only if dialog mode is open.
Note: This method is only available if Guides DIALOG is enabled.This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the ShowSignatureCaptureCompleted event is raised. Your application must handle this event to receive notification.
SoftwareUpdate()
Force the EFT Terminal to start a Software Update.
Declaration
public UpdateStatus SoftwareUpdate()
Returns
Type | Description |
---|---|
UpdateStatus | the UpdateStatus |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the softwareUpdate |
SoftwareUpdateAsync()
Asynchronously forces the EFT Terminal to start a Software Update.
Declaration
public void SoftwareUpdateAsync()
Remarks
This method does not block the calling thread during the softwareUpdate and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the SoftwareUpdateCompleted event is raised. Your application must handle this event to receive notification. The response is available in the UpdateStatus as Terminal.SoftwareUpdateCompletedEventArgs.
StartCheckout()
Start checkout process.
Declaration
public void StartCheckout()
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
StartCheckoutAsync()
Start checkout process.
Declaration
public void StartCheckoutAsync()
Remarks
Note: This method is only available if Guides VALUE_ADDED_SERVICES is enabled.
This method does not block the calling thread during the application information operation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the StartCheckoutCompleted event is raised. Your application must handle this event to receive notification.
SystemInformation()
Request system information from the EFT Terminal.
Declaration
public SystemInformationResponse SystemInformation()
Returns
Type | Description |
---|---|
SystemInformationResponse | the SystemInformationResponse |
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the systemInformation |
SystemInformationAsync()
Asynchronously request system information from the EFT Terminal.
Declaration
public void SystemInformationAsync()
Remarks
This method does not block the calling thread during the activation and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the SystemInformationCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.SystemInformationCompletedEventArgs as SystemInformationResponse
TimApiDispose()
dispose of TimApi to release all resources.
Declaration
public static void TimApiDispose()
Transaction(TransactionType, Amount)
Starts an EFT Terminal Transaction.
Declaration
public TransactionResponse Transaction(TransactionType type, Amount amount)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function. |
Amount | amount | Transaction amount. |
Returns
Type | Description |
---|---|
TransactionResponse | the TransactionResponse |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
Exceptions
Type | Condition |
---|---|
TimException | an error occurred during the transaction |
Transaction(TransactionType, TransactionRequest)
Starts an EFT Terminal Transaction.
Declaration
public TransactionResponse Transaction(TransactionType type, TransactionRequest request)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function. |
TransactionRequest | request | Transaction parameters without using TransactionRequest property. |
Returns
Type | Description |
---|---|
TransactionResponse | The TransactionResponse. |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
Exceptions
Type | Condition |
---|---|
TimException | An error occurred during the transaction. |
TransactionAsync(TransactionType, Amount)
Starts a transactions the terminal asynchronously.
Declaration
public void TransactionAsync(TransactionType type, Amount amount)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | |
Amount | amount |
Remarks
This method does not block the calling thread during the transaction and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the TransactionCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.TransactionCompletedEventArgs as TransactionResponse.
TransactionAsync(TransactionType, TransactionRequest)
Asynchronously starts an EFT Terminal Transaction.
Declaration
public void TransactionAsync(TransactionType type, TransactionRequest request)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function. |
TransactionRequest | request | Transaction parameters without using TransactionRequest property |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
This method does not block the calling thread during the transaction and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the TransactionCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.TransactionCompletedEventArgs as TransactionResponse.
TransactionCashback(TransactionType, Amount, Amount)
Starts an EFT Terminal Transaction with Cashback amount.
Declaration
public TransactionResponse TransactionCashback(TransactionType type, Amount amount, Amount amountOther)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function |
Amount | amount | Transaction amount. |
Amount | amountOther | cashback amount. |
Returns
Type | Description |
---|---|
TransactionResponse | The TransactionResponse. |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
TransactionCashbackAsync(TransactionType, Amount, Amount)
Asynchronously starts an EFT Terminal Transaction with Cashback amount.
Declaration
public void TransactionCashbackAsync(TransactionType type, Amount amount, Amount amountOther)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function |
Amount | amount | Transaction amount. |
Amount | amountOther | Cashback amount. |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
This method does not block the calling thread during the transaction and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the TransactionCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.TransactionCompletedEventArgs as TransactionResponse.
TransactionTip(TransactionType, Amount, Amount)
Starts an EFT Terminal Transaction.
Declaration
public TransactionResponse TransactionTip(TransactionType type, Amount amount, Amount tipAmount)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function |
Amount | amount | Transaction amount. |
Amount | tipAmount | Proposed tip amount. |
Returns
Type | Description |
---|---|
TransactionResponse | The TransactionResponse. |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
TransactionTipAsync(TransactionType, Amount, Amount)
Asynchronously starts an EFT Terminal Transaction.
Declaration
public void TransactionTipAsync(TransactionType type, Amount amount, Amount tipAmount)
Parameters
Type | Name | Description |
---|---|---|
TransactionType | type | Financial Transaction Function |
Amount | amount | Transaction amount. |
Amount | tipAmount | Proposed tip amount. |
Remarks
Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).
This method does not block the calling thread during the transaction and uses the Event-based Asynchronous Pattern (EAP). When the transaction completes, the TransactionCompleted event is raised. Your application must handle this event to receive notification. The response is available in the Terminal.TransactionCompletedEventArgs as TransactionResponse.
WaitCommandComplete(Int32)
Declaration
protected bool WaitCommandComplete(int timeout)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | timeout |
Returns
Type | Description |
---|---|
System.Boolean |
Events
ActivateCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.ActivateCompletedEventHandler ActivateCompleted
Event Type
Type | Description |
---|---|
Terminal.ActivateCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the ActivateAsync() methods.
The Terminal.ActivateCompletedEventHandler is the delegate for this event.
The Terminal.ActivateCompletedEventArgs class provides the event handler with event data.
ActivateServiceMenuCompleted
Occurs when an asynchronous ActivateServiceMenu completes.
Declaration
public event Terminal.ActivateServiceMenuCompletedEventHandler ActivateServiceMenuCompleted
Event Type
Type | Description |
---|---|
Terminal.ActivateServiceMenuCompletedEventHandler |
Remarks
This event is raised each time an asynchronous CloseMaintenanceWindow completes.
Asynchronous operations are started by calling the CloseMaintenanceWindowAsync() methods.
The Terminal.ActivateServiceMenuCompletedEventHandler is the delegate for this event.
The Terminal.ActivateServiceMenuCompletedEventArgs class provides the event handler with event data.
ApplicationInformationCompleted
Occurs when an asynchronous ApplicationInformation completes.
Declaration
public event Terminal.ApplicationInformationCompletedEventHandler ApplicationInformationCompleted
Event Type
Type | Description |
---|---|
Terminal.ApplicationInformationCompletedEventHandler |
Remarks
This event is raised each time an asynchronous ApplicationInformation completes.
Asynchronous transactions are started by calling the ApplicationInformationAsync() methods.
The Terminal.ApplicationInformationCompletedEventHandler is the delegate for this event.
The Terminal.ApplicationInformationCompletedEventArgs class provides the event handler with event data.
BalanceCompleted
Occurs when an asynchronous balance completes.
Declaration
public event Terminal.BalanceCompletedEventHandler BalanceCompleted
Event Type
Type | Description |
---|---|
Terminal.BalanceCompletedEventHandler |
Remarks
This event is raised each time an asynchronous balance completes.
Asynchronous transactions are started by calling the BalanceAsync() methods.
The Terminal.BalanceCompletedEventHandler is the delegate for this event.
The Terminal.BalanceCompletedEventArgs class provides the event handler with event data.
BalanceInquiryCompleted
Occurs when an asynchronous BalanceInquiry completes.
Declaration
public event Terminal.BalanceInquiryCompletedEventHandler BalanceInquiryCompleted
Event Type
Type | Description |
---|---|
Terminal.BalanceInquiryCompletedEventHandler |
Remarks
This event is raised each time an asynchronous BalanceInquiry completes.
Asynchronous operations are started by calling the BalanceInquiryAsync() methods.
The Terminal.BalanceInquiryCompletedEventHandler is the delegate for this event.
The Terminal.BalanceInquiryCompletedEventArgs class provides the event handler with event data.
ChangeSettingsCompleted
Occurs when an asynchronous ChangeSettings completes.
Declaration
public event Terminal.ChangeSettingsCompletedEventHandler ChangeSettingsCompleted
Event Type
Type | Description |
---|---|
Terminal.ChangeSettingsCompletedEventHandler |
Remarks
This event is raised each time an asynchronous ChangeSettings completes.
Asynchronous ChangeSettings is started by calling the ChangeSettingsAsync(List<Setting>) method.
The Terminal.ChangeSettingsCompletedEventHandler is the delegate for this event.
The Terminal.ChangeSettingsCompletedEventArgs class provides the event handler with event data.
CloseDialogModeCompleted
Occurs when an asynchronous CloseDialogMode completes.
Declaration
public event Terminal.CloseDialogModeCompletedEventHandler CloseDialogModeCompleted
Event Type
Type | Description |
---|---|
Terminal.CloseDialogModeCompletedEventHandler |
Remarks
This event is raised each time an asynchronous CloseDialogMode completes.
Asynchronous operations are started by calling the CloseDialogModeAsync() methods.
The Terminal.CloseDialogModeCompletedEventHandler is the delegate for this event.
The Terminal.CloseDialogModeCompletedEventArgs class provides the event handler with event data.
CloseMaintenanceWindowCompleted
Occurs when an asynchronous CLoseMaintenanceWindow completes.
Declaration
public event Terminal.CloseMaintenanceWindowCompletedEventHandler CloseMaintenanceWindowCompleted
Event Type
Type | Description |
---|---|
Terminal.CloseMaintenanceWindowCompletedEventHandler |
Remarks
This event is raised each time an asynchronous CloseMaintenanceWindow completes.
Asynchronous operations are started by calling the CloseMaintenanceWindowAsync() methods.
The Terminal.CloseMaintenanceWindowCompletedEventHandler is the delegate for this event.
The Terminal.CloseMaintenanceWindowCompletedEventArgs class provides the event handler with event data.
CloseReaderCompleted
Occurs when an asynchronous CloseReader completes.
Declaration
public event Terminal.CloseReaderCompletedEventHandler CloseReaderCompleted
Event Type
Type | Description |
---|---|
Terminal.CloseReaderCompletedEventHandler |
Remarks
This event is raised each time an asynchronous CloseReader completes.
Asynchronous operations are started by calling the CloseReaderAsync() methods.
The Terminal.CloseReaderCompletedEventHandler is the delegate for this event.
The Terminal.CloseReaderCompletedEventArgs class provides the event handler with event data.
CommitCompleted
Occurs when an asynchronous Commit completes.
Declaration
public event Terminal.CommitCompletedEventHandler CommitCompleted
Event Type
Type | Description |
---|---|
Terminal.CommitCompletedEventHandler |
Remarks
This event is raised each time an asynchronous Commit completes.
Asynchronous transactions are started by calling the CommitAsync() methods.
The Terminal.CommitCompletedEventHandler is the delegate for this event.
The Terminal.CommitCompletedEventArgs class provides the event handler with event data.
ConnectCompleted
Called if an "Connect" started request finished.
Declaration
public event Terminal.ConnectCompletedHandler ConnectCompleted
Event Type
Type | Description |
---|---|
Terminal.ConnectCompletedHandler |
Remarks
exception Contains the terminal sending the event and error information if the request failed.
CounterRequestCompleted
Occurs when an asynchronous counterRequest completes.
Declaration
public event Terminal.CounterRequestCompletedEventHandler CounterRequestCompleted
Event Type
Type | Description |
---|---|
Terminal.CounterRequestCompletedEventHandler |
Remarks
This event is raised each time an asynchronous counterRequest completes.
Asynchronous transactions are started by calling the CounterRequestAsync(CounterType) methods.
The Terminal.CounterRequestCompletedEventHandler is the delegate for this event.
The Terminal.CounterRequestCompletedEventArgs class provides the event handler with event data.
DccRatesCompleted
Occurs when an asynchronous dccRates operation completes.
Declaration
public event Terminal.DccRatesCompletedEventHandler DccRatesCompleted
Event Type
Type | Description |
---|---|
Terminal.DccRatesCompletedEventHandler |
Remarks
This event is raised each time an asynchronous dccRates operation completes.
Asynchronous dccRates operations are started by calling the DccRatesAsync() methods.
The Terminal.DccRatesCompletedEventHandler is the delegate for this event.
The Terminal.DccRatesCompletedEventArgs class provides the event handler with event data.
DeactivateCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.DeactivateCompletedEventHandler DeactivateCompleted
Event Type
Type | Description |
---|---|
Terminal.DeactivateCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the DeactivateAsync() methods.
The Terminal.DeactivateCompletedEventHandler is the delegate for this event.
The Terminal.DeactivateCompletedEventArgs class provides the event handler with event data.
Disconnected
Connection to terminal closed.
Declaration
public event Terminal.DisconnectedHandler Disconnected
Event Type
Type | Description |
---|---|
Terminal.DisconnectedHandler |
Remarks
Called if user disconnected or connection has been lost. exception Contains the error information for the reasen on Disconnected.
EjectCardCompleted
Occurs when an asynchronous EjectCard completes.
Declaration
public event Terminal.EjectCardCompletedEventHandler EjectCardCompleted
Event Type
Type | Description |
---|---|
Terminal.EjectCardCompletedEventHandler |
Remarks
This event is raised each time an asynchronous EjectCard completes.
Asynchronous operations are started by calling the EjectCardAsync() methods.
The Terminal.EjectCardCompletedEventHandler is the delegate for this event.
The Terminal.EjectCardCompletedEventArgs class provides the event handler with event data.
FinishCheckoutCompleted
Occurs when an asynchronous OpenDialogMode completes.
Declaration
public event Terminal.FinishCheckoutCompletedEventHandler FinishCheckoutCompleted
Event Type
Type | Description |
---|---|
Terminal.FinishCheckoutCompletedEventHandler |
Remarks
This event is raised each time an asynchronous FinishCheckout completes.
Asynchronous operations are started by calling the FinishCheckoutAsync() methods.
The Terminal.FinishCheckoutCompletedEventHandler is the delegate for this event.
The Terminal.FinishCheckoutCompletedEventArgs class provides the event handler with event data.
HardwareInformationCompleted
Occurs when an asynchronous HardwareInformation completes.
Declaration
public event Terminal.HardwareInformationCompletedEventHandler HardwareInformationCompleted
Event Type
Type | Description |
---|---|
Terminal.HardwareInformationCompletedEventHandler |
Remarks
This event is raised each time an asynchronous HardwareInformation operation completes.
Asynchronous transactions are started by calling the HardwareInformationAsync() methods.
The Terminal.HardwareInformationCompletedEventHandler is the delegate for this event.
The Terminal.HardwareInformationCompletedEventArgs class provides the event handler with event data.
InitTransactionCompleted
Occurs when an asynchronous InitTransaction completes.
Declaration
public event Terminal.InitTransactionCompletedEventHandler InitTransactionCompleted
Event Type
Type | Description |
---|---|
Terminal.InitTransactionCompletedEventHandler |
Remarks
This event is raised each time an asynchronous InitTransaction completes.
Asynchronous transactions are started by calling the InitTransactionAsync(Boolean, Amount) methods.
The Terminal.InitTransactionCompletedEventHandler is the delegate for this event.
The Terminal.InitTransactionCompletedEventArgs class provides the event handler with event data.
LoginCompleted
Occurs when an asynchronous Login completes.
Declaration
public event Terminal.LoginCompletedEventHandler LoginCompleted
Event Type
Type | Description |
---|---|
Terminal.LoginCompletedEventHandler |
Remarks
This event is raised each time an asynchronous Login completes.
Asynchronous transactions are started by calling the LoginAsync() methods.
The Terminal.LoginCompletedEventHandler is the delegate for this event.
The Terminal.LoginCompletedEventArgs class provides the event handler with event data.
LogoutCompleted
Occurs when an asynchronous Logout completes.
Declaration
public event Terminal.LogoutCompletedEventHandler LogoutCompleted
Event Type
Type | Description |
---|---|
Terminal.LogoutCompletedEventHandler |
Remarks
This event is raised each time an asynchronous Logout completes.
Asynchronous logouts are started by calling the LogoutAsync() methods.
The Terminal.LogoutCompletedEventHandler is the delegate for this event.
The Terminal.LogoutCompletedEventArgs class provides the event handler with event data.
LoyaltyDataCompleted
Occurs when an asynchronous LoyaltyData completes.
Declaration
public event Terminal.LoyaltyDataCompletedEventHandler LoyaltyDataCompleted
Event Type
Type | Description |
---|---|
Terminal.LoyaltyDataCompletedEventHandler |
Remarks
This event is raised each time an asynchronous LoyaltyData completes.
Asynchronous operations are started by calling the LoyaltyDataAsync(LoyaltyFunctionType, String, Byte[], Boolean) methods.
The Terminal.LoyaltyDataCompletedEventHandler is the delegate for this event.
The
OpenDialogModeCompleted
Occurs when an asynchronous OpenDialogMode completes.
Declaration
public event Terminal.OpenDialogModeCompletedEventHandler OpenDialogModeCompleted
Event Type
Type | Description |
---|---|
Terminal.OpenDialogModeCompletedEventHandler |
Remarks
This event is raised each time an asynchronous OpenDialogMode completes.
Asynchronous operations are started by calling the OpenDialogModeAsync() methods.
The Terminal.OpenDialogModeCompletedEventHandler is the delegate for this event.
The Terminal.OpenDialogModeCompletedEventArgs class provides the event handler with event data.
OpenMaintenanceWindowCompleted
Occurs when an asynchronous OpenMaintenanceWindow completes.
Declaration
public event Terminal.OpenMaintenanceWindowCompletedEventHandler OpenMaintenanceWindowCompleted
Event Type
Type | Description |
---|---|
Terminal.OpenMaintenanceWindowCompletedEventHandler |
Remarks
This event is raised each time an asynchronous OpenMaintenanceWindow completes.
Asynchronous operations are started by calling the OpenMaintenanceWindowAsync() methods.
The Terminal.OpenMaintenanceWindowCompletedEventHandler is the delegate for this event.
The Terminal.OpenMaintenanceWindowCompletedEventArgs class provides the event handler with event data.
OpenReaderCompleted
Occurs when an asynchronous OpenReader completes.
Declaration
public event Terminal.OpenReaderCompletedEventHandler OpenReaderCompleted
Event Type
Type | Description |
---|---|
Terminal.OpenReaderCompletedEventHandler |
Remarks
This event is raised each time an asynchronous OpenReader completes.
Asynchronous operations are started by calling the OpenReaderAsync() methods.
The Terminal.OpenReaderCompletedEventHandler is the delegate for this event.
The Terminal.OpenReaderCompletedEventArgs class provides the event handler with event data.
PrintOnTerminalCompleted
Occurs when an asynchronous PrintOnTerminal completes.
Declaration
public event Terminal.PrintOnTerminalCompletedEventHandler PrintOnTerminalCompleted
Event Type
Type | Description |
---|---|
Terminal.PrintOnTerminalCompletedEventHandler |
Remarks
This event is raised each time an asynchronous PrintOnTerminal completes.
Asynchronous operations are started by calling the PrintOnTerminalAsync(String) methods.
The Terminal.PrintOnTerminalCompletedEventHandler is the delegate for this event.
The Terminal.PrintOnTerminalCompletedEventArgs class provides the event handler with event data.
ProvideLoyaltyBasketCompleted
Occurs when an asynchronous OpenDialogMode completes.
Declaration
public event Terminal.ProvideLoyaltyBasketCompletedEventHandler ProvideLoyaltyBasketCompleted
Event Type
Type | Description |
---|---|
Terminal.ProvideLoyaltyBasketCompletedEventHandler |
Remarks
This event is raised each time an asynchronous OpenDialogMode completes.
Asynchronous operations are started by calling the OpenDialogModeAsync() methods.
The Terminal.OpenDialogModeCompletedEventHandler is the delegate for this event.
The Terminal.OpenDialogModeCompletedEventArgs class provides the event handler with event data.
ProvideVasResultCompleted
Occurs when an asynchronous ProvideVasResult completes.
Declaration
public event Terminal.ProvideVasResultCompletedEventHandler ProvideVasResultCompleted
Event Type
Type | Description |
---|---|
Terminal.ProvideVasResultCompletedEventHandler |
Remarks
This event is raised each time an asynchronous ProvideVasResult completes.
Asynchronous operations are started by calling the ProvideVasResultAsync(VasResult) methods.
The Terminal.ProvideVasResultCompletedEventHandler is the delegate for this event.
The Terminal.ProvideVasResultCompletedEventArgs class provides the event handler with event data.
RebootCompleted
Occurs when an asynchronous Reboot completes.
Declaration
public event Terminal.RebootCompletedEventHandler RebootCompleted
Event Type
Type | Description |
---|---|
Terminal.RebootCompletedEventHandler |
Remarks
This event is raised each time an asynchronous reboot completes.
Asynchronous reboots are started by calling the RebootAsync() methods.
The Terminal.RebootCompletedEventHandler is the delegate for this event.
The Terminal.RebootCompletedEventArgs class provides the event handler with event data.
ReceiptRequestCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.ReceiptRequestCompletedEventHandler ReceiptRequestCompleted
Event Type
Type | Description |
---|---|
Terminal.ReceiptRequestCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the ReceiptRequestAsync(ReceiptRequestType) methods.
The Terminal.ReceiptRequestCompletedEventHandler is the delegate for this event.
The Terminal.ReceiptRequestCompletedEventArgs class provides the event handler with event data.
ReconciliationCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.ReconciliationCompletedEventHandler ReconciliationCompleted
Event Type
Type | Description |
---|---|
Terminal.ReconciliationCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the ReconciliationAsync() methods.
The Terminal.ReconciliationCompletedEventHandler is the delegate for this event.
The Terminal.ReconciliationCompletedEventArgs class provides the event handler with event data.
ReconfigCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.ReconfigCompletedEventHandler ReconfigCompleted
Event Type
Type | Description |
---|---|
Terminal.ReconfigCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the ReconfigAsync() methods.
The Terminal.ReconfigCompletedEventHandler is the delegate for this event.
The Terminal.ReconfigCompletedEventArgs class provides the event handler with event data.
RequestAliasCompleted
Occurs when an asynchronous RequestAlias completes.
Declaration
public event Terminal.RequestAliasCompletedEventHandler RequestAliasCompleted
Event Type
Type | Description |
---|---|
Terminal.RequestAliasCompletedEventHandler |
Remarks
This event is raised each time an asynchronous RequestAlias completes.
Asynchronous operations are started by calling the RequestAliasAsync(String) methods.
The Terminal.RequestAliasCompletedEventHandler is the delegate for this event.
The Terminal.RequestAliasCompletedEventArgs class provides the event handler with event data.
RollbackCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.RollbackCompletedEventHandler RollbackCompleted
Event Type
Type | Description |
---|---|
Terminal.RollbackCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the RollbackAsync() methods.
The Terminal.RollbackCompletedEventHandler is the delegate for this event.
The Terminal.RollbackCompletedEventArgs class provides the event handler with event data.
SendCardCommandCompleted
Occurs when an asynchronous SendCardCommand completes.
Declaration
public event Terminal.SendCardCommandCompletedEventHandler SendCardCommandCompleted
Event Type
Type | Description |
---|---|
Terminal.SendCardCommandCompletedEventHandler |
Remarks
This event is raised each time an asynchronous SendCardCommand completes.
Asynchronous operations are started by calling the SendCardCommandAsync(List<CommandRequest>) methods.
The Terminal.SendCardCommandCompletedEventHandler is the delegate for this event.
The Terminal.SendCardCommandCompletedEventArgs class provides the event handler with event data.
ShowDialogCompleted
Occurs when an asynchronous ShowDialog completes.
Declaration
public event Terminal.ShowDialogCompletedEventHandler ShowDialogCompleted
Event Type
Type | Description |
---|---|
Terminal.ShowDialogCompletedEventHandler |
Remarks
This event is raised each time an asynchronous ShowDialog completes.
Asynchronous operations are started by calling the ShowDialogAsync(ShowDialogRequest) methods.
The Terminal.ShowDialogCompletedEventHandler is the delegate for this event.
The Terminal.ShowDialogCompletedEventArgs class provides the event handler with event data.
ShowSignatureCaptureCompleted
Occurs when an asynchronous ShowSignatureCapture completes.
Declaration
public event Terminal.ShowSignatureCaptureCompletedEventHandler ShowSignatureCaptureCompleted
Event Type
Type | Description |
---|---|
Terminal.ShowSignatureCaptureCompletedEventHandler |
Remarks
This event is raised each time an asynchronous ShowSignatureCapture completes.
Asynchronous operations are started by calling the ShowSignatureCaptureAsync(ShowSignatureCaptureRequest) methods.
The Terminal.ShowSignatureCaptureCompletedEventHandler is the delegate for this event.
The Terminal.ShowSignatureCaptureCompletedEventArgs class provides the event handler with event data.
SoftwareUpdateCompleted
Occurs when an asynchronous activation completes.
Declaration
public event Terminal.SoftwareUpdateCompletedEventHandler SoftwareUpdateCompleted
Event Type
Type | Description |
---|---|
Terminal.SoftwareUpdateCompletedEventHandler |
Remarks
This event is raised each time an asynchronous activation completes.
Asynchronous transactions are started by calling the SoftwareUpdateAsync() methods.
The Terminal.SoftwareUpdateCompletedEventHandler is the delegate for this event.
The Terminal.SoftwareUpdateCompletedEventArgs class provides the event handler with event data.
StartCheckoutCompleted
Occurs when an asynchronous StartCheckout completes.
Declaration
public event Terminal.StartCheckoutCompletedEventHandler StartCheckoutCompleted
Event Type
Type | Description |
---|---|
Terminal.StartCheckoutCompletedEventHandler |
Remarks
This event is raised each time an asynchronous StartCheckout completes.
Asynchronous operations are started by calling the OpenDialogModeAsync() methods.
The Terminal.StartCheckoutCompletedEventHandler is the delegate for this event.
The Terminal.StartCheckoutCompletedEventArgs class provides the event handler with event data.
SystemInformationCompleted
Occurs when an asynchronous SystemInformation completes.
Declaration
public event Terminal.SystemInformationCompletedEventHandler SystemInformationCompleted
Event Type
Type | Description |
---|---|
Terminal.SystemInformationCompletedEventHandler |
Remarks
This event is raised each time an asynchronous SystemInformation completes.
Asynchronous SystemInformation are started by calling the SystemInformationAsync() methods.
The Terminal.SystemInformationCompletedEventHandler is the delegate for this event.
The Terminal.SystemInformationCompletedEventArgs class provides the event handler with event data.
TerminalStatusChanged
Occurs when the status changes on the terminal.
Declaration
public event Terminal.TerminalStatusChangedHandler TerminalStatusChanged
Event Type
Type | Description |
---|---|
Terminal.TerminalStatusChangedHandler |
Remarks
This event is raised each timethe status changes on the terminal.
TransactionCompleted
Occurs when an asynchronous transaction completes.
Declaration
public event Terminal.TransactionCompletedEventHandler TransactionCompleted
Event Type
Type | Description |
---|---|
Terminal.TransactionCompletedEventHandler |
Remarks
This event is raised each time an asynchronous transaction completes.
Asynchronous transactions are started by calling the TransactionAsync(TransactionType, Amount) methods.
The Terminal.TransactionCompletedEventHandler is the delegate for this event.
The Terminal.TransactionCompletedEventArgs class provides the event handler with event data.
VasInfo
Occurs whenVasInfo is available.
Declaration
public event Terminal.VasInfoHandler VasInfo
Event Type
Type | Description |
---|---|
Terminal.VasInfoHandler |
Remarks
This event is raised each timethe status changes on the terminal.