Package eu.ccvlab.mapi.core.api

Interface TerminalApi

  • public interface TerminalApi

    • Method Detail

      • status

        default void status​(ExternalTerminal terminal,
                    TerminalDelegate terminalDelegate)
        Fetch the status of the terminal
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • repeatLastMessage

        default void repeatLastMessage​(ExternalTerminal terminal,
                               TerminalDelegate terminalDelegate)
        Repeat the last payment result
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • reprintLastTicket

        @Deprecated
default void reprintLastTicket​(ExternalTerminal terminal,
                               TerminalDelegate terminalDelegate)
        Deprecated.
        use retrieveLastTicket(ExternalTerminal, TerminalDelegate) instead.
        Reprint the ticket created during the latest sale.
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • retrieveLastTicket

        default void retrieveLastTicket​(ExternalTerminal terminal,
                                TerminalDelegate terminalDelegate)
        Retrieve the ticket created during the latest sale.
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • readMifareUID

        default void readMifareUID​(ExternalTerminal terminal,
                           TokenDelegate tokenDelegate)
        Read UID of Card
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        tokenDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • transactionOverview

        default void transactionOverview​(ExternalTerminal terminal,
                                 TerminalDelegate terminalDelegate)
        Get transaction overview
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • periodClosing

        default void periodClosing​(ExternalTerminal terminal,
                           TerminalDelegate terminalDelegate)
        Perform period closing
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • partialPeriodClosing

        default void partialPeriodClosing​(ExternalTerminal terminal,
                                  TerminalDelegate terminalDelegate)
        Perform partial period closing
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • ticketReprintPeriodClosing

        default void ticketReprintPeriodClosing​(ExternalTerminal terminal,
                                        TerminalDelegate terminalDelegate)
        Perform ticket reprint for the last period closing
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • recoverPayment

        default void recoverPayment​(ExternalTerminal terminal,
                            java.lang.String paymentRequestId,
                            TerminalDelegate terminalDelegate)
        Verify if your last performed payment is the same as the last performed payment on the terminal. When these 2 are the same, the result and the according tickets are returned.
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        paymentRequestId - RequestId of the payment you want to know the result of. This requestId will be used to check if the retrieved payment result is corresponding with the desired payment.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • cardCircuits

        default void cardCircuits​(ExternalTerminal terminal,
                          TerminalDelegate terminalDelegate)
        Fetch the available card circuits of the terminal This functionality is only available on the IM30 pax terminal
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • activateTerminal

        default void activateTerminal​(ExternalTerminal terminal,
                              TerminalDelegate terminalDelegate)
        Activate Terminal OPI-CH only
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • startup

        default void startup​(ExternalTerminal terminal,
                     TerminalDelegate terminalDelegate)
        Startup Terminal OPI-CH only
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

      • terminalAdministrationOperation

        default void terminalAdministrationOperation​(ExternalTerminal terminal,
                                             TerminalAdministrationRequest terminalAdministrationRequest,
                                             TerminalDelegate terminalDelegate)
        Terminal Administration Operation OPI-NL Unattended only
        Parameters:
        terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
        terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure
        terminalAdministrationRequest - terminal administration information that needs to be sent to the terminal

      • unsupported

        static void unsupported()