Skip to main content

Dojo API

Learn more about the Dojo API, a consolidated offering of online payments and face-to-face payments.

The Dojo API is a REST API, that fully integrates legacy Pay at Counter operations with the existing Payments feature set. The technical nature of this work has prompted the first breaking change to Dojo Payments, as it merged remote and face-to-face payment capabilities.

The Terminals API is currently in beta.

Authentication

Main page: API keys

The API uses HTTP basic authentication to grant access to customer-owned resources.

Headers

  • version: The API version with format yyyy-mm-dd. The current version is 2024-02-05.
  • software-house-id: This is field shows the EPOS company whose software is generating the request. This value should not be configurable as it will remain the same for all customers using particular EPOS software.
  • reseller-id: This identifies the reseller of the EPOS. This may be the same as the software-house-id if they are also the seller.

Beta

Pay at Counter is currently in beta. Any pages discussing beta functionality will use the tag BETA.