Local Terminal API

Viva's Local Terminal API enables network-agnostic, peer-to-peer communication between EFT POS (card terminal) devices and ECR systems. This protocol empowers seamless interaction, allowing you to initiate sales, refunds, and other transactions across devices within the same network.

• Overview
• Supported Devices
• Process Flow
• API Documentation
• Get Support

Overview

Viva’s peer-to-peer communication relies on the HTTP protocol and REST API for transaction initiation and data exchange between the client and the host (the terminal/device with Viva.com Terminal application) in the same network. The client device can be any device capable of sending HTTP requests to the terminal’s local IP address.

Supported Devices

Viva’s REST API (EFT POS) functionality is supported by:

• Android devices (including Tap-on-Phone, Viva Contactless Terminal powered by Google Play, Viva Contactless Terminal with Professional Scanner powered by Google Play & Viva Contactless / Chip & PIN Terminal powered by Google Play)
• iOS devices - including support for Apple Tap to Pay in the UK, the Netherlands, France, Austria, Czech Republic, Ireland, Romania, and Sweden, Italy & Germany
• Paydroid devices: A920 Pro, A35, A80 (devices with Android 10 or later)

Process Flow

The below diagram outlines the relationship and process flow between the systems involved in peer-to-peer communication communication:

The steps of the above process flow are explained below:

1. The Electronic Cash Register (ECR) initiates a transaction by sending a request to the targeted EFT POS device’s IP address.

2. The POS responds to the ECR, indicating whether the transaction is accepted and in progress or not.

3. Upon receiving a “PROCESSING” response, the ECR enters a polling state, regularly querying the POS IP address to check the status of the initial request.

4. Once the end customer completes the transaction and the POS operation concludes, the POS displays the transaction outcome.

5. Subsequent polling request from the ECR to the POS retrieves the full transaction details.

API Documentation

Please see our Local Terminal API Documentation

Get Support

If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!