Ping a terminal | Run Developers

Pings a terminal to confirm it’s reachable. Requires an active session (see Connect a terminal session).

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.

Response

Ping response

device_idstringOptional

Hardware Serial Number of the terminal.

terminalIdstringOptional

Terminal ID.

connectedbooleanOptional

Connection status.

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error