Skip to navigation
Terminal APITerminals

Connect a terminal session

Manually connects a terminal session. The read-card and charge-card endpoints connect automatically if no session is active, so use this endpoint to pre-connect a terminal or force a reconnect.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Path parameters

device_idstringRequired

Hardware Serial Number (HSN) of the terminal, provided by your Integration Delivery lead.

Query parameters

midstringOptional

Merchant ID. Required when your bearer token is an ISV token acting on behalf of a merchant. If the mid can't be resolved to an authorized account, the request returns 400.

Request

This endpoint expects an object.
forcebooleanOptionalDefaults to false
Force a reconnect even if a session is already active.

Response

Terminal connected
device_idstring
Hardware Serial Number of the connected terminal.
connectedboolean

Connection status. true on success.

session_keystring
Session token for subsequent terminal operations.

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error