myPOS ePOS API

Bridge digital applications with physical payment terminals. Initiate and manage card-present transactions directly from web, mobile, or desktop platforms.

Partners Portal — Integration Setup

When adding a new integration in the Partners Portal, select the following dropdown values:

These settings ensure your integration is correctly configured for the ePOS API.

Channel

POS Payments

Type

Cash Register

Device Compatibility

The myPOS ePOS API is currently available exclusively for: myPOS Carbon, myPOS Ultra, myPOS Sigma, and myPOS Flex. Please ensure your terminal model is compatible before proceeding.

Whether you're running a retail point-of-sale system, a self-service kiosk, or a custom enterprise application, the ePOS API allows for fast, secure, and flexible payment processing without compromising on user experience or compliance.

The API is PCI-compliant and offers real-time transaction feedback, multi-terminal support, and smart routing capabilities.

What Does the ePOS API Do?

Core capabilities of the ePOS integration

Initiate Payments

Send payment requests to connected myPOS terminals directly from your application.

Display on Device

Automatically show amount and transaction context on the terminal screen.

Process Cards

Handle card payments securely via the terminal with PCI-compliant processing.

Real-time Status

Retrieve transaction results and statuses instantly as they happen.

This eliminates the need for manual input on the terminal and ensures a smooth checkout process driven entirely from your application.

Swagger API SpecificationJSON

Download documentation for the API endpoints

Core Use Cases

Common integration scenarios for the ePOS API

Retail POS Systems

Send payment instructions from your software to a nearby myPOS terminal

Unattended Solutions

Enable kiosk or vending applications to trigger and complete payments

Mobile Sales Platforms

Empower mobile apps to integrate payment functionality on the go

Order Management Systems

Automate billing from a central dashboard to multiple terminals

Key Features

What makes the ePOS API powerful

Secure by Design

PCI-compliant communication between client apps and terminals

Real-Time Transactions

Instant feedback on payment approvals, declines, or cancellations

Seamless Integration

RESTful architecture with standardized request/response formats

Multi-terminal Support

Manage and operate multiple terminals across locations

Smart Routing

Select specific terminals based on availability, ID, or location context

Benefits

Why choose the ePOS API

⚡

Faster Checkouts

Enhanced customer experience through streamlined payment flow

🎛️

Full Control

Manage the entire payment flow from within your application

🎯

Reduced Errors

Automated transaction initiation minimizes human mistakes

📈

Scalability

Grow with multiple payment endpoints across locations

🔒

No Sensitive Data

Ensures compliance and reduced risk for your business

API Methods

Explore the available ePOS API endpoints

Payment

Initiate, process, and manage payment transactions on connected terminals.

PurchaseRefundStatus

Terminal

Manage and monitor your connected myPOS terminals and their status.

ListStatusConfig

Need help with integration? Contact our developer support team for personalized guidance.

POS API V2

For terminal management and receipt data, see POS API V2: Terminals and Receipts. The V2 reference includes authentication, filtering, pagination, identifier guidance and migration notes. Existing V1 payment and terminal endpoints remain documented separately.