Terminal Sessions
Terminal sessions allow you to establish a connection with the terminal (via the Dojo API) and prepare it for processing payments. The terminal session will update its notification events throughout its lifecycle which can be displayed to the POS user.
Both Sale and Matched Refund require a payment intent to be created and passed in the request body, where an Unlinked Refund is not linked to a previous captured sale and can be initiated without.
Status
The Terminal Session Status represents the various stages in a terminal session lifecycle. As a Terminal Session progresses from creation to fulfilment, its status will update to reflect its current state.
| Status | Description |
|---|---|
InitiateRequested | The request to begin the session has been submitted to the Terminal and is awaiting confirmation. |
Initiated | The session has been confirmed by the Terminal and is awaiting payment to be taken. |
Authorized | The payment has been authorized pending final capture (Pre-authorization). |
Captured | Payment has now been captured and no further updates will be made to the session. |
CancelRequested | The request to cancel the session has been submitted to the Terminal and is awaiting confirmation. |
Canceled | The session has been canceled by the Terminal. |
SignatureVerificationRequired | Payment has been captured pending signature verification. |
SignatureVerificationAccepted | Payment has been captured after successful signature verification signature verification. |
SignatureVerificationRejected | Payment has been reversed following rejection of signature verification. |
Expired | The terminal session has expired. |
Declined | Payment has been declined by the card issuer. |
These statuses help track the state of each session and ensure that any integrated systems can react to updates in a consistent manner.