Package eu.ccvlab.mapi.core.api

Interface TerminalApi

public interface TerminalApi

  • Method Details

    • status

      @Deprecated(since="1.32", forRemoval=true) default void status(ExternalTerminal terminal, TerminalDelegate terminalDelegate)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getStatus

      default void getStatus(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

    • repeatLastServiceMessage

      default void repeatLastServiceMessage(ExternalTerminal terminal, TerminalDelegate terminalDelegate)
      Repeat the last service request 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, 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

    • retrieveOpenPreAuthorisations

      default void retrieveOpenPreAuthorisations(ExternalTerminal terminal, TerminalDelegate terminalDelegate)

    • 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

    • showDisplay

      @Deprecated default void showDisplay(ExternalTerminal terminal, DisplayRequest displayRequest, TerminalDelegate terminalDelegate)
      Deprecated.
      use onlineAgent(ExternalTerminal, OnlineAgentRequest, TerminalDelegate) (ExternalTerminal, OnlineAgentRequest, TerminalDelegate)} instead.
      Terminal Show Display OPI-NL 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
      displayRequest - display information that needs to be shown on the terminal

    • cardDetection

      default void cardDetection(ExternalTerminal terminal, CardDetectionRequest cardDetectionRequest, TerminalDelegate terminalDelegate)

    • onlineAgent

      default void onlineAgent(ExternalTerminal terminal, OnlineAgentRequest onlineAgentRequest, TerminalDelegate terminalDelegate)

    • abort

      default void abort(boolean isSilent, ExternalTerminal terminal, TerminalDelegate terminalDelegate)
      Currently only supported for OPI-NL Aborts an ongoing terminal action.
      Parameters:
      isSilent - the silent abort prevents that the "Aborted" customer display message isn't shown after performing an abort.
      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

    • abortOnNewConnection

      default void abortOnNewConnection(boolean isSilent, ExternalTerminal terminal, TerminalDelegate terminalDelegate)
      Currently only supported for OPI-NL Aborts an ongoing terminal action. The abort will be sent using a new connection.
      Parameters:
      isSilent - the silent abort prevents that the "Aborted" customer display message isn't shown after performing an abort.
      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

    • showSales

      default void showSales(ExternalTerminal terminal, eu.ccvlab.mapi.core.terminal.SalesType salesType, TerminalDelegate terminalDelegate)
      PrintTotalRevenue and PrintIntermediateRevenue
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      salesType - declares the kind of sales view: Total (shows all sales per card and transaction) Intermediate (shows the sales just once per request until new transactions to be shown have been made)
      terminalDelegate - Callback hook towards the caller to inform regarding success/status/failure

    • login

      default void login(ExternalTerminal terminal, TerminalDelegate terminalDelegate)
      Login command checks if all components are connected.
      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

    • unsupported

      static void unsupported()