Skip to main content

TMS APIs

Available with any integration path

TMS APIs are available regardless of which card-present integration path you chose. Merchant configuration, terminal management, and feature flags are managed server-side and apply to all integration paths. A partner-level API key (distinct from the merchant transaction key) is required.

The Terminal Management System (TMS) APIs allow you to manage merchants, terminals, and feature configuration programmatically.

Base URL​

https://tms.handpoint.com

Authentication​

Authorization: YOUR_PARTNER_API_KEY

TMS APIs require a partner-level API key, distinct from the merchant transaction API key.

Key operations​

List terminals​

GET /terminals
Authorization: YOUR_PARTNER_API_KEY

Get terminal status​

GET /terminals/{serial_number}

Terminal status values: U (unactivated) → I (initialized) → A (active) → C (closed) → X (disabled)

Onboard a merchant​

POST /merchants
Content-Type: application/json

{
  "name": "Merchant Name",
  "acquirer": "tsys-us",
  "mcc": "5812"
}

Assign terminal to merchant​

POST /merchants/{merchant_id}/terminals
Content-Type: application/json

{ "serial_number": "123456789" }
info

TMS APIs are available to ISV partners. Contact your Handpoint business development contact to enable partner API access.