How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Dojo

Dojo Terminal sessions API

Allows you to manage sessions on the terminal.

Documentation Provider Profile APIs.io OpenAPI GitHub

Dojo Terminal sessions API is one of 19 APIs that Dojo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Terminal sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 2026-02-27.

Requests are made against a single base URL, https://api.dojo.tech.

4 operations 4 paths 26 schemas 1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-02-27
Base URL
https://api.dojo.tech
Authentication
API Key
Contact
Dojo Developer Experience Team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Dojo Terminal sessions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Terminal sessions 4

Allows you to manage sessions on the terminal.

POST
/terminal-sessions
Create a session on a terminal
TerminalSession_Create 3 params body → 200400401404
GET
/terminal-sessions/{terminalSessionId}
Retrieve a terminal session
TerminalSession_Get 4 params → 200400401404
PUT
/terminal-sessions/{terminalSessionId}/cancel
Request the cancellation of a terminal session
TerminalSession_Cancel 4 params → 200400401404422
PUT
/terminal-sessions/{terminalSessionId}/signature
Respond to a signature verification request
TerminalSession_Signature 4 params body → 200400401404422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are TerminalSession (11 properties), Card (8 properties), PaymentDetails (7 properties), ProblemDetailsTerminals (6 properties). Each schema is shown below with its type and property counts.

TerminalSessionReceiptTextSize
string
Decide the size of included receipt text.
CardFundingType
string
The main funding types are credit, debit, pre-paid, and charge.
TerminalSessionReceiptLine
object
The value and configuration of the terminal session receipt line.
3 properties 1 required
TerminalSessionNotificationType
string
Terminal notifications. (Approved, Declined, InsertCard, EnterPin, PleaseWait, PresentCard, PresentOnlyOneCard, RemoveCard, CardUnsupported, CardError, ReEnter…
PaymentDetails
object
The payment details object.
7 properties
Money
object
The amount intended to be collected by this payment intent excluding tipsAmount serviceChargeAmount and cashbackAmount.
2 properties 2 required
CreateTerminalSessionRequest
object
Create a terminal session, and decide what sort of transaction it is going to be associated with. Note that only one of the refund types can be specified, and…
2 properties 2 required
ProblemDetailsTerminals
object
Dojo follows the error response format proposed in [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807), also known as Problem Details for HTTP APIs.
6 properties 6 required
TerminalSessionStatusEvent
object
The current progress of the terminal session, including whether it is in-progress or finished.
3 properties 3 required
SignatureVerificationRequest
object
Request to the EPOS to confirm whether the signature has been accepted or not in a payment that requires signature verification. This request must be replied t…
1 property 1 required
TerminalSessionNotificationEvent
object
This event is a timestamped record of when a notification was issued.
2 properties 2 required
TerminalSessionReceiptText
object
Edit the content of text included with the terminal session receipt, and configure the text's appearance.
4 properties 4 required
TerminalSessionDetails
object
Details about the terminal session, including which type of transaction it is associated with.
4 properties 1 required
TerminalSessionStatus
string
The current status of the terminal session. A finalized, successful session will be Captured.
TerminalSessionSaleDetails
object
Use this field when creating a terminal session request to name a payment intent by its ID to associate with the session.
1 property 1 required
TerminalSessionMatchedRefundDetails
object
A matched refund is associated with the payment intent of the initial transaction.
2 properties 1 required
TerminalSessionReceiptAlign
string
Align the receipt text to the center, to the left, or to the right.
TerminalSession
object
This is the terminal session object, containing detailed information about the history of the terminal session, and its current status.
11 properties 8 required
TerminalSessionReceipt
object
The receipt object is a record of the transactions associated with a terminal session.
1 property 1 required
TerminalSessionPaymentVerificationMode
string
Method used to verify that the person presenting the card is the legitimate cardholder. The most common verification methods are PIN and signature. (Pin, Signa…
TerminalSessionReceiptLineType
string
These are the line types that will form the physical receipt.
TerminalSessionReceiptImageLogo
object
An optional logo can be added to the terminals receipt.
2 properties 2 required
TerminalSessionPaymentEntryMode
string
Entry mode of the payment. (Contactless, ContactChip, Magstripe, ManualEntry, Unknown)
Card
object
8 properties
TerminalSessionUnlinkedRefundDetails
object
A refund which is not linked to any previous transaction.
2 properties 1 required
TerminalSessionType
string
Decide which type of transaction a terminal session is going to be associated with.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dojo-terminal-sessions-api-openapi.yml Raw ↑

Other APIs Dojo publishes across the network.

Dojo Areas API
AE Profile APIs.io
Dojo Capabilities API
AE Profile APIs.io
Dojo Captures API
AE Profile APIs.io
Dojo Customers API
AE Profile APIs.io
Dojo Events API
AE Profile APIs.io
Dojo Flows API
AE Profile APIs.io
Dojo Orders API
AE Profile APIs.io
Dojo Parties API
AE Profile APIs.io
Dojo Payment intents API
AE Profile APIs.io
Dojo Refunds API
AE Profile APIs.io
Dojo Reservations API
AE Profile APIs.io
Dojo Reversal API
AE Profile APIs.io
#Terminal sessions
← Back to D APIs
API Details
ID
dojo:dojo-terminal-sessions-api
Base URL
https://api.dojo.tech
Docs
https://docs.dojo.tech/api
Provider
Dojo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=dojo-terminal-sessions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dojo-terminal-sessions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Dojo Terminal sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.