Getting Started for ECR Integration with Maya Terminals

Overview

This guide walks you through the requirements and setup needed before integrating your Electronic Cash Register (ECR) with Maya Terminals.

Before proceeding, we recommend reviewing the page About ECR Integration with Maya Terminals to understand:

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

By the end of this guide, you will know the tools, credentials, and configurations required before starting development.

Getting Started

Step 1: Define the Scope

Identify the specific ECR and Maya Terminal model you plan to integrate. Take note of:

• Hardware and software requirements
• Supported operating systems
• Preferred payment methods (card, QRPh, e-wallets)

This ensures compatibility and reduces integration issues later.

Step 2: Sign up for a Maya Business Account

To access Maya’s developer tools and order terminals, you need a Maya Business Account.

2.1. Go to Maya Business Manager and create an account.

2.2. Complete KYC requirements:

• Fill out your business profile

• Upload necessary documents (e.g., valid IDs, business permits, SEC/DTI registration)

• Provide your preferred setup details

  2.3. Approval & Activation: Once verified, your account will be activated and you will gain access to the Maya Business Manager.

For help during onboarding, email [email protected].

If you are an existing partner, reach out to your dedicated Maya Relationship Manager.

Step 3: Order Your Maya Terminals

Once your business account is active:

3.1. In Maya Business Manager, navigate to PayMaya One → Get Terminals.

3.2. Select:

• Device type (PAX A920 or Sunmi P2)

• Quantity

• Branch assignment

• Delivery address

• Projected transaction volume

  3.3. Confirm your order.

Maya Terminals will be delivered to your store. You can track order status in Maya Business Manager.

Step 4: Prepare the Hardware

Before integration, ensure your hardware and tools are ready.

Host Computer

• Confirm compatibility with the required USB drivers (Windows/Linux).
• Install the drivers provided for your terminal type.

Maya Terminal Kit (PAX A920 or Sunmi P2)

The Maya Terminal Kit includes:

• USB data cable
• Pre-installed Maya applications:
  • ECR App
  • Maya One App
  • QR Pay App (PAX only)
• (Optional) L920 Cradle – for PAX terminals with LAN connectivity
• Latest Maya ECR API/Interface Specifications
• ECR UAT Test Cases for validation
• Maya ECR Simulation Tool (e.g., remote-serial-pay.py) – recommended for testing and debugging
• USB Drivers with installation guides:
  • Windows: PAX or Sunmi
  • Linux: PAX

You must sign a Non-Disclosure Agreement (NDA) with Maya to receive the full integration kit. Reach out to your designated Maya Relationship Manager or email [email protected], to request for the kit.

Step 5: Configure and Integrate

With your hardware ready:

1. Review the following:
   • ECR Interface Specifications provided by Maya
   • ECR Integration Limitations
   • Asynchronous and Synchronous Flows in ECR Integration
   • Preparation for ECR Integration
2. Develop your merchant ECR plugin or integration layer
3. Apply the Best Practices:
   • Understanding the ECR Command Statuses
   • Handling Cancellation in ECR-Integrated Terminal
   • Managing Voids and Refunds in ECR-Integrated Terminal
4. Connect the Maya Terminal to the host computer (USB or RS-232)
5. Handle errors gracefully by Understanding Errors in ECR Integration
6. Simulate transactions during development or debug your integration Using the ECR Simulator Tool

Step 6: Perform User Acceptance Testing

• Get the test cases from the ECR Integration Kit, refer to the file Maya ECR Partner UAT Test Cases
• Prepare for UAT by Setting Up Sandbox Test Data for ECR Integration
• Ensure that you execute all the test cases provided

Step 7: Go Live

When ready, coordinate with your Maya Relationship Manager and complete the Go Live Checklist below:

Before Going to Production

• Accomplish the Maya ECR Partner UAT Test Cases
• Submit your sign-off to your designated Maya Relationship Manager
• Coordinate with your Maya Relationship Manager on the Go-live date
• Prepare for production. This includes:
  • Setting up your production Maya Business Manager or Maya Manager 1.0 account

After Going Live in Production

• Conduct pilot testing in production using real payment methods (charges will apply).
• Submit your final sign-off
• Prepare for your public launch

For production support, email [email protected]. Do NOT raise production issues in ASKAMAYADEV.

FAQs

Q: Do I need a Maya Business Account before ordering terminals?

A: Yes. Terminal ordering and integration access are only available after your business account is verified and activated.

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

A: No. The ECR Tool is for simulation and debugging only in test environments.

Q: What if I already have Maya Terminals?

A: You can proceed to hardware preparation and integration.

Q: Will Maya provide test cases for ECR Integration?

A: Yes. It will be provided along with the ECR Integration Kit.

Q: Is there a certification process required before going live?

A: Maya Terminals are already certified. However, to ensure smooth production deployment, Maya recommends that the UAT tests be executed

Next Steps

You have now integrated your ECR to the Maya Terminal following the guides and best practices.

• For merchant account-related requests (e.g., feature enablement), reach out to your Maya Relationship Manager.
• If you run into issues in Production, check the Understanding Errors in ECR Integration for proper handling.