Preparation for ECR Integration

Overview

This guide walks you through the steps required to integrate Maya Terminals into your Electronic Cash Register (ECR).

By the end of this guide, you will be able to:

• Connect Maya Terminals to your ECR
• Configure the environment for communication
• Validate transactions using the Maya ECR Integration Kit

Before You Begin

Review the About ECR Integration with Maya Terminals page to understand:

• Supported Maya Terminals
• Integration requirements
• Key concepts and architecture

Prerequisites

Make sure the following are complete before starting integration:

• You have a verified Maya Business Manager or Maya Manager 1.0 account.
• You have ordered and received your Maya Terminals.
• You have requested and received the latest ECR Integration Kit (includes drivers, specifications, test cases, and tools).

Integration Setup

Step 1: Develop your own Merchant ECR Plugin

Your ECR Plugin acts as the middleware between your ECR and the Maya Terminal.

It is responsible for sending and receiving transaction messages, handling errors, and managing retries.

1. Review the ECR Interface Specifications from the Integration Kit
2. Implement the flow logic based on the command type. See Asynchronous and Synchronous Flows in ECR Integration
3. Implement message handling, error codes, and retry logic as documented

Step 2: Prepare the Maya Terminal for ECR Communication

Before testing your integration, make sure your Maya Terminal is properly connected to the host computer.

Connect via USB

1. Use the USB cable provided in the Maya Terminal kit.
2. Connect the Maya Terminal to your host computer via a USB port.

For Sunmi devices: Connection is typically via USB-C; ensure the device is recognized automatically once connected.

Configure Connection Type (for PAX A920 with L920 Cradle)

1. On the Maya Terminal, open the ECR App.
2. Go to Settings → Connection Type.
3. Choose one of the following:
   • L920-RS232 – RS232 cable with RJ45 end (cradle connection)
   • L920-USB SLAVE – USB-A cable (cradle connection)
4. Restart the ECR App.
5. Tap Scan to Pair, then scan the barcode on the back of the L920 cradle.

Step 3: Run the ECR Application in the Maya Terminal

1. On the terminal, launch the pre-installed ECR App.
2. Confirm that the notification shows: “ECR Started / Connected to USB.”
3. If the message does not appear:
   • Restart the ECR App.
   • Reconnect the cable.
   • Verify that the connection type is set correctly.

Step 4: Installing Drivers Manually (when needed)

In some cases, drivers may need to be installed manually, especially if the terminal is not detected automatically.

When to Install Manually:

• The terminal is not listed under “Ports (COM & LPT)” in Device Manager.
• The terminal appears as Unknown Device.
• Communication attempts return port or USB connection errors.

To install manually:

1. Request the latest PAX or Sunmi USB driver package from your Maya Relationship Manager.
2. Refer to the installation guide provided along with the package.

Step 5: Verify the Serial Port on the Host Computer

Before sending or receiving transaction commands, verify that the terminal’s COM port or device path is correctly detected by your system.

On Windows

1. Connect the Maya Terminal via USB.
   • The required driver usually installs automatically.
2. Open Device Manager → Ports (COM & LPT).
3. Locate the COM port entry for your terminal (e.g., COM11).
   • Ignore entries labeled “Daemon.”
4. Use the detected COM port number in your ECR Plugin configuration.
5. Confirm that the same port number appears after reconnecting the terminal.
   • If it changes, configure a fixed COM port in Windows to ensure consistency.

On Linux / Unix / macOS

1. Open a terminal and run: ls /dev/
2. Look for a device path like /dev/ttyUSB0 or /dev/ttyACM0.
3. Use this device path in your ECR integration configuration.
4. If the path changes after reconnection:
   • Create udev rules or persistent device naming to maintain stability.

Verification Checklist

Before starting integration testing:

• The ECR Plugin is installed and configured with the correct COM port or device path.
• The Maya Terminal displays “ECR Connected” in the ECR App.
• The terminal appears under Ports (COM & LPT) in Device Manager.
• You can send and receive test commands between the ECR Plugin and the terminal.

FAQs

Q: Do I need a Maya Business Account before starting integration?

A: Yes. Integration is only available after your account is verified and your terminals are active.

Q: What is included in the ECR Integration Kit?

A: It includes ECR API/Interface specifications, USB drivers, test cases, and a simulation tool.

Q: Can I use the Maya ECR Simulation Tool in production?

A: No. The simulation tool is strictly for testing and debugging in UAT environments.

Q: What if I already have Maya Terminals?

A: You can skip the ordering process and proceed directly with hardware setup and integration.

Next Steps

You are now ready to integrate your ECR with the Maya Terminal.

Before proceeding, make sure to follow the best practices and proper handling guidelines below:

• Keep your ECR and Maya applications regularly updated to prevent compatibility and version-related issues.
• Understand Command Statuses – Learn how to interpret and handle different terminal responses. See: Understanding the ECR Command Statuses
• Handle Timeouts – Ensure your ECR properly manages communication and transaction timeouts. See: Handling Timeouts in ECR-Integrated Terminal
• Simulate Transactions – Test your setup Using the ECR Simulator Tool before connecting to a live terminal.
• Manage Errors – Identify and troubleshoot integration or terminal errors effectively. See: Understanding Errors in ECR Integration