Package eu.ccvlab.mapi.core.terminal
Class ExternalTerminal
- java.lang.Object
-
- eu.ccvlab.mapi.core.terminal.ExternalTerminal
-
@Immutable public class ExternalTerminal extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExternalTerminal.Mode
Deprecated.this class will be removed by the end of 2021, useExternalTerminal.SocketMode
insteadstatic class
ExternalTerminal.SocketMode
static class
ExternalTerminal.TerminalType
The type of terminal (attended / unattended) with the protocol it expects (opi-nl / opi-de)
-
Field Summary
Fields Modifier and Type Field Description private OpiCommunicationDelegate
communicationDelegate
This parameter will only be assigned when the socket-connection to the terminal is already established, this should not be used in the default local/SDK implementationprivate int
compatibilityPort
private java.lang.String
customerEmailAddress
private java.lang.String
ipAddress
private eu.ccvlab.mapi.core.terminal.LanguageCode
languageCode
private java.lang.String
merchantEmailAddress
private ExternalTerminal.Mode
mode
private boolean
partialApprovalAllowed
OPI_DE only PartialApprovalAllowed indicates the terminal if the ECR can process partial approvalsprivate PasswordLevel
passwordLevel
private int
port
private PrinterStatusType
printerStatus
private boolean
requestTransactionInformation
OPI_NL only RequestTransactionInformation is used to ask the terminal for additional info of the transaction in case the transaction is declined.private java.lang.Integer
shiftNumber
private ExternalTerminal.SocketMode
socketMode
private boolean
supportMifareCards
OPI_NL UNATTENDED only supportMifareCards is used to allow the support of MifareCards while performing a CardDetection of PreAuthorisationprivate eu.ccvlab.mapi.core.terminal.TerminalAccessedBy
terminalAccessedBy
private java.util.List<eu.ccvlab.mapi.core.terminal.TerminalDisplayText>
terminalDisplayText
UnAttended terminals only Only 2 TerminalDisplayText are allowed When 2 TerminalDisplayText objects are passed then both need to have a different TerminalDisplayTextWindow (ScreenWaitForCard and ScreenAtWaitForFollowUp)private java.lang.String
terminalId
private ExternalTerminal.TerminalType
terminalType
private java.lang.String
workstationId
-
Constructor Summary
Constructors Constructor Description ExternalTerminal()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
compatibilityPort()
4102 for OPI-NL and 20007 for OPI-DEjava.lang.String
customerEmailAddress()
The customerEmailAddress is used to hand over the email address from the customer to the payment engine or further connected systems behind.boolean
equals(java.lang.Object o)
int
hashCode()
java.lang.String
ipAddress()
The IP-address of the terminalboolean
isAttendedTerminal()
eu.ccvlab.mapi.core.terminal.LanguageCode
languageCode()
LanguageCode is used to change the default language of the terminal for the duration of a transactionjava.lang.String
merchantEmailAddress()
The merchantEmailAddress is used to hand over the email address from the merchant to the payment engine or further connected systems behind.ExternalTerminal.Mode
mode()
Dual-Socket only used for OPI-NL Single-Socket used for OPI-DE and OPI-NLstatic lombok.Builder
newBuilder()
Deprecated.use builder()int
port()
4100 for OPI-NL and 20002 for OPI-DEPrinterStatusType
printerStatus()
Gets printer availability status.boolean
requestTransactionInformation()
OPI_NL only RequestTransactionInformation is used to ask the terminal for additional info of the transaction in case the transaction is declined.java.lang.Integer
shiftNumber()
The ShiftNumber is used to create a total during a specific shiftExternalTerminal.SocketMode
socketMode()
Dual-Socket only used for OPI-NL Single-Socket used for OPI-DE and OPI-NLboolean
supportMifareCards()
OPI_NL UNATTENDED only supportMifareCards is used to allow the support of MifareCards while performing a CardDetection of PreAuthorisationjava.util.List<eu.ccvlab.mapi.core.terminal.TerminalDisplayText>
terminalDisplayText()
The terminalDisplayText is used to show custom text on the terminal while performing an payment.java.lang.String
terminalId()
The terminalId can be used to identify and control the configuration that is loaded on the terminalExternalTerminal.TerminalType
terminalType()
EnumType which contains terminal protocol combined attended/unattended typejava.lang.String
workstationId()
The WorkstationID is used to identify a specific POS.
-
-
-
Field Detail
-
ipAddress
private java.lang.String ipAddress
-
port
private int port
-
compatibilityPort
private int compatibilityPort
-
mode
private ExternalTerminal.Mode mode
-
socketMode
private ExternalTerminal.SocketMode socketMode
-
terminalType
private ExternalTerminal.TerminalType terminalType
-
languageCode
private eu.ccvlab.mapi.core.terminal.LanguageCode languageCode
-
shiftNumber
private java.lang.Integer shiftNumber
-
workstationId
private java.lang.String workstationId
-
terminalId
private java.lang.String terminalId
-
communicationDelegate
private OpiCommunicationDelegate communicationDelegate
This parameter will only be assigned when the socket-connection to the terminal is already established, this should not be used in the default local/SDK implementation
-
terminalAccessedBy
private eu.ccvlab.mapi.core.terminal.TerminalAccessedBy terminalAccessedBy
-
merchantEmailAddress
private java.lang.String merchantEmailAddress
-
customerEmailAddress
private java.lang.String customerEmailAddress
-
printerStatus
private final PrinterStatusType printerStatus
-
terminalDisplayText
private java.util.List<eu.ccvlab.mapi.core.terminal.TerminalDisplayText> terminalDisplayText
UnAttended terminals only Only 2 TerminalDisplayText are allowed When 2 TerminalDisplayText objects are passed then both need to have a different TerminalDisplayTextWindow (ScreenWaitForCard and ScreenAtWaitForFollowUp)
-
requestTransactionInformation
private boolean requestTransactionInformation
OPI_NL only RequestTransactionInformation is used to ask the terminal for additional info of the transaction in case the transaction is declined.
-
supportMifareCards
private boolean supportMifareCards
OPI_NL UNATTENDED only supportMifareCards is used to allow the support of MifareCards while performing a CardDetection of PreAuthorisation
-
passwordLevel
private PasswordLevel passwordLevel
-
partialApprovalAllowed
private boolean partialApprovalAllowed
OPI_DE only PartialApprovalAllowed indicates the terminal if the ECR can process partial approvals
-
-
Method Detail
-
ipAddress
public java.lang.String ipAddress()
The IP-address of the terminal- Returns:
- the string
-
port
public int port()
4100 for OPI-NL and 20002 for OPI-DE- Returns:
- the int
-
compatibilityPort
public int compatibilityPort()
4102 for OPI-NL and 20007 for OPI-DE- Returns:
- the int
-
mode
public ExternalTerminal.Mode mode()
Dual-Socket only used for OPI-NL Single-Socket used for OPI-DE and OPI-NL- Returns:
- the mode
-
socketMode
public ExternalTerminal.SocketMode socketMode()
Dual-Socket only used for OPI-NL Single-Socket used for OPI-DE and OPI-NL- Returns:
- the socketMode
-
isAttendedTerminal
public boolean isAttendedTerminal()
-
newBuilder
@Deprecated public static lombok.Builder newBuilder()
Deprecated.use builder()- Returns:
- the backwards compatible builder
-
terminalType
public ExternalTerminal.TerminalType terminalType()
EnumType which contains terminal protocol combined attended/unattended type- Returns:
- the terminal type
-
languageCode
public eu.ccvlab.mapi.core.terminal.LanguageCode languageCode()
LanguageCode is used to change the default language of the terminal for the duration of a transaction- Returns:
- the languageCode
-
shiftNumber
public java.lang.Integer shiftNumber()
The ShiftNumber is used to create a total during a specific shift- Returns:
- the shiftNumber
-
workstationId
public java.lang.String workstationId()
The WorkstationID is used to identify a specific POS. The WorkstationID must be unique in the LAN.- Returns:
- the workstationId
-
terminalId
public java.lang.String terminalId()
The terminalId can be used to identify and control the configuration that is loaded on the terminal- Returns:
- the terminalId
-
merchantEmailAddress
public java.lang.String merchantEmailAddress()
The merchantEmailAddress is used to hand over the email address from the merchant to the payment engine or further connected systems behind.- Returns:
- the merchantEmailAddress
-
customerEmailAddress
public java.lang.String customerEmailAddress()
The customerEmailAddress is used to hand over the email address from the customer to the payment engine or further connected systems behind.- Returns:
- the customerEmailAddress
-
terminalDisplayText
public java.util.List<eu.ccvlab.mapi.core.terminal.TerminalDisplayText> terminalDisplayText()
The terminalDisplayText is used to show custom text on the terminal while performing an payment.- Returns:
- the merchantEmailAddress
-
printerStatus
public PrinterStatusType printerStatus()
Gets printer availability status.- Returns:
- the printer availability status
-
requestTransactionInformation
public boolean requestTransactionInformation()
OPI_NL only RequestTransactionInformation is used to ask the terminal for additional info of the transaction in case the transaction is declined.- Returns:
- requestTransactionInformation
-
supportMifareCards
public boolean supportMifareCards()
OPI_NL UNATTENDED only supportMifareCards is used to allow the support of MifareCards while performing a CardDetection of PreAuthorisation- Returns:
- supportMifareCards
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-