Skip to main content

Getting started

Hello!​

We're thrilled to show you our ECR REST API, this article should help you navigate the foundations of our platform.
Let's create something amazing together!

How does it work?​

We recommend reading the following sections to get a good understanding of our API:

  • Network Requirements: Your application can operate on the merchants local network, or let the terminal run as a client to long-poll a server to send operations to the terminal without being reliant on finding the terminal on the merchants local network.
  • Connection Models: Sync, Async or WAN? This article outlines the general flow of a transaction.
  • API Capabilities: The API is currently available in two major branches, make sure you look at their capabilities to see which one fits your use-case.

If you've already familiarized yourself with the API make sure to read through the integration guidelines as these will be verified in the mandatory certification once your application is ready.

Where do I start?​

If you're not a partner yet, head on over to ordering test equipment to get in touch with our partner sales team.

If you're already a partner, contact your account manager or the Integration Team to get started with the process.