Dojo

Dojo Terminals API

Allows you to manage payments on the terminal. **Documentation**: [Terminals](../payments/accept-payments/in-person-payments/pay-at-counter/terminals)

GitHub OpenAPI

Operations 2

GET /terminals Retrieve all terminals #
GET /terminals/{terminalId} Retrieve a terminal #

Documentation

📖
Documentation
https://docs.dojo.tech/docs
📖
APIReference
https://docs.dojo.tech/api
📖
Documentation
https://docs.dojo.tech/transactions
📖
APIReference
https://docs.dojo.tech/transactions/api
📖
Documentation
https://docs.dojo.tech/api-hosting/epos-data
📖
APIReference
https://docs.dojo.tech/epos-data/api
📖
Documentation
https://docs.dojo.tech/payments/accept-payments/in-person-payments/tap-to-pay/tap-to-pay-on-iphone
📖
APIReference
https://docs.dojo.tech/payments/accept-payments/in-person-payments/tap-to-pay/tap-to-pay-on-iphone/api
📖
Documentation
https://docs.dojo.tech/epos-tester-tool
📖
APIReference
https://docs.dojo.tech/epos-tester-tool/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dojo/refs/heads/main/openapi/dojo-terminals-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/dojo/refs/heads/main/asyncapi/dojo-epos-data-asyncapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/dojo/refs/heads/main/openapi/_original/dojo-api.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dojo-terminals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dojo-terminals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dojo Terminals API
  version: '2026-02-27'
  description: '# Introduction


    The Dojo API is a REST API, using HTTP response codes to convey status, including successful responses and errors.'
  termsOfService: https://dojo.tech/legal/
  contact:
    name: Dojo Developer Experience Team
servers:
- url: https://api.dojo.tech
security:
- ApiKeyAuth: []
tags:
- name: Terminals
  description: 'Allows you to manage payments on the terminal.

    **Documentation**: Terminals'
paths:
  /terminals:
    get:
      tags:
      - Terminals
      parameters:
      - name: statuses
        description: A machine-readable value describing the state of the terminal. Terminals with any of the statuses provided in this parameter will be listed.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/TerminalStatus'
        in: query
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/SoftwareHouseId'
      - $ref: '#/components/parameters/ResellerId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Terminal'
              example:
              - id: tm_sandbox_65c5fe8a104a1222b2d8b968
                properties:
                  tid: VCMPYC8SIP0
                status: Available
                updatedAt: '2024-02-09T10:29:30.213Z'
              - id: tm_sandbox_65c5fe8a104a1222b2d8b666
                properties:
                  tid: VCMPYC8SIP2
                status: Available
                updatedAt: '2024-02-09T10:30:30.213Z'
          description: A list of terminals.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
      operationId: Terminals_ListTerminals
      summary: Retrieve all terminals
      description: Allows you to retrieve details of all terminals.
  /terminals/{terminalId}:
    get:
      tags:
      - Terminals
      parameters:
      - example: tm_sandbox_65c5fe8a104a12xxxxxxxxxx
        name: terminalId
        description: The unique identifier for the terminal.
        schema:
          type: string
        in: path
        required: true
        x-position: 1
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/SoftwareHouseId'
      - $ref: '#/components/parameters/ResellerId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Terminal'
              example:
                id: tm_sandbox_65c5fe8a104a1222b2d8b968
                properties:
                  tid: VCMPYC8SIP0
                status: Available
                updatedAt: '2024-02-09T10:29:30.213Z'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Not found
      operationId: Terminals_GetTerminal
      summary: Retrieve a terminal
      description: Retrieve a terminal by using its ID.
components:
  schemas:
    TerminalProperties:
      description: Properties related to the terminal.
      required:
      - tid
      type: object
      properties:
        tid:
          description: An 8-digit identifier printed on receipts.
          type: string
          example: '12345678'
    ErrorCode:
      description: 'Machine-usable code describing an error.

        (INTERNAL_ERROR, TERMINAL_UNAVAILABLE, INVALID_REQUEST)'
      type: string
    Terminal:
      title: Terminal
      description: The terminal object.
      required:
      - id
      - properties
      - status
      - updatedAt
      type: object
      properties:
        id:
          description: The unique identifier for the terminal.
          type: string
          example: tm_sandbox_amxm22C23
        properties:
          $ref: '#/components/schemas/TerminalProperties'
        status:
          $ref: '#/components/schemas/TerminalStatus'
        updatedAt:
          format: date-time
          description: The timestamp of the update date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.
          type: string
    Error:
      description: An object containing information about an error that occurred as part of an API request.
      required:
      - code
      - title
      - type
      - status
      - traceId
      - errors
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        title:
          description: 'A short, human-readable summary of the error.

            '
          type: string
        type:
          description: 'A URI reference [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) identifying the problem type.

            '
          type: string
        status:
          description: 'The [HTTP status code](#section/Introduction/HTTP-Responses).

            '
          type: integer
        detail:
          description: 'A human-readable message giving more details about the error. Not always present.

            '
          type: string
        traceId:
          description: 'The unique identifier of the failing request.

            '
          type: string
        errors:
          description: An object containing information about an error that occurred as part of an API request.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    TerminalStatus:
      title: TerminalStatus
      description: A machine-readable value describing the state of the terminal.
      enum:
      - Available
      - Offline
      - InUse
      type: string
  parameters:
    SoftwareHouseId:
      name: software-house-id
      description: This 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.
      schema:
        type: string
      example: softwareHouse1
      in: header
      required: true
    ResellerId:
      name: reseller-id
      description: This identifies the reseller of the EPOS. This may be the same as the `software-house-id` if they are also the seller.
      schema:
        type: string
      example: reseller1
      in: header
      required: false
    Version:
      name: version
      in: header
      required: true
      schema:
        type: string
        format: date
      example: '2026-02-27'
      description: The API version with format yyyy-mm-dd. The current version is `2026-02-27`.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
x-tagGroups:
- name: Core payments
  tags:
  - Payment intents
  - Refunds
  - Reversal
  - Captures
  - Webhooks
  - Customers
  - Setup intents
- name: In-person payments
  tags:
  - Terminals
  - Terminal sessions
- name: Capabilities
  tags:
  - Capabilities
  - Events