DOdojo
Terminal sessions

Create a session on a terminal

post/terminal-sessions

Request

Headers

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

software-house-idstring required

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.

reseller-idstring

This identifies the reseller of the EPOS. This may be the same as the software-house-id if they are also the seller.

Request body

terminalIdstring required

The unique identifier for the terminal.

Example request

{
  "terminalId": "tm_sandbox_amxm22C23",
  "details": {
    "sale": {
      "paymentIntentId": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw"
    }
  }
}

Response

Terminal session created.

terminalIdstring required

The unique identifier for the terminal.

createdAtstring date-time required

This is when the terminal session was created, in ISO 8601 UTC format.

updatedAtstring date-time required

The timestamp of the update date, in ISO 8601 UTC format.

idstring required

The unique identifier of the terminal session.

status'InitiateRequested' | 'Initiated' | 'Authorized' | 'Captured' | 'CancelRequested' | 'Canceled' | 'SignatureVerificationAccepted' | 'SignatureVerificationRejected' | 'SignatureVerificationRequired' | 'Expired' | 'Declined' required

The current status of the terminal session. A finalized, successful session will be Captured.

expireAtstring date-time required

The timestamp and date of when a terminal session will be marked as Expired, in ISO 8601 UTC format. This changes throughout the life cycle of a terminal session as it moves to different states.

Example response

{
  "id": "ts_sandbox_RBMHTJ4fIkmSppDILZVCGw",
  "details": {
    "sale": {
      "paymentIntentId": "pi_sandbox_RBMHTJ4fIkmSppDILZVCGw"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.