SDK Guides / Online Agent - Android SDK

Intro

The function OnlineAgent is used to access different kinds of applications of the terminal: CardTunnel and UserInterface.

CardTunnel (only possible for ApasPP/acCEPT OPI-NL terminals)

The following code snippet demonstrates how you can use the CardTunnel application to send APDU commands to Mifare cards. This is only possible for ApasPP/acCEPT OPI-NL terminals.

    TerminalApi terminalService = new TerminalService();
    ExternalTerminal terminal = createExternalTerminal();

    TerminalDelegate terminalDelegate = new terminalDelegate() {
        ...

        @Override
        public void onPaymentAdministrationSuccess(PaymentAdministrationResult result) {
            // Contains the CardSlotNo, CardStatus and Reponse code
            result.tunnelResponse();
        }

        ...
    };

    terminalService.onlineAgent(
        terminal, 
        OnlineAgentRequest.builder()
            .applicationId("CardTunnel")
            .tunnelRequest(
                TunnelRequest.builder()
                    .cardSlotNo(CardSlotNo.CUSTOMER_CONTACTLESS_READER)
                    .command("BCA40000022901")
                    .build())
                .build(), 
            terminalDelegate);

UserInterface

The following code snippet demonstrates how you can use the UserInterface application to use the terminal as a screen only if the POS does not have a primary screen

    TerminalApi terminalService = new TerminalService();
    ExternalTerminal terminal = createExternalTerminal();

    TerminalDelegate terminalDelegate = new terminalDelegate() {
    ...
    };

    terminalService.onlineAgent(
        terminal, 
        OnlineAgentRequest.builder()
            .applicationId("UserInterface")
            .displayRequest(DisplayRequest.builder()
                .delayedResponse(true)
                .displayLines(List.of("This is the title", "This is the body", "This is the footer"))
                .buttons(List.of(
                    Button.builder().keyBeep(KeyBeep.On).name("submitButton").value("Submit button").build(),
                    Button.builder().keyBeep(KeyBeep.On).name("newCharge").value("New Charge button").build()
                    ))
                .bottomLineButton("OK_CANCEL")
                .screenBeep(ScreenBeep.RequestBeep)
                .eReceiptUrl("https://ereceipturl.com/test")
                .build())
            .build(), 
            terminalDelegate);

Flexo

We support possibility to customize the CardServiceRequest Flexo tag fully using the FlexoRequest class.

    TerminalApi terminalService = new TerminalService();
    ExternalTerminal terminal = createExternalTerminal();

    TerminalDelegate terminalDelegate = new terminalDelegate() {
    ...
    };

    terminalService.onlineAgent(
        terminal, 
        OnlineAgentRequest.builder()
            .applicationId("Flexo")
            .flexoRequest(Flexo.builder()
                .serviceName("Mifare")
                .scriptName("DISPLAY_AND_BEEP")
                .param(List.of(
                        Param.builder()
                                .name("line1")
                                .value("MiFare Contactless")
                                .build(),
                        Param.builder()
                                .name("line2")
                                .value("Transactie akkoord")
                                .build(),
                        Param.builder()
                                .name("beep")
                                .value("SuccessBeep")
                                .build()))
                .build())
            .build(),
            terminalDelegate);