Docs/API/Terminals

Terminals

List terminals registered to your account. Transactions for a specific terminal are sent through the standard transaction endpoint.

Terminal transactions — in-person EMV, swipe, or contactless — are processed through the regular Sale / Auth endpoint by setting payment_method.terminal and supplying the terminal ID. This page documents the one helper endpoint for retrieving terminal metadata.

List all terminals

GET /api/terminals

Returns every terminal registered to your gateway account — active and inactive.

{
  "status": "success",
  "msg": "",
  "total_count": 1,
  "data": [
    {
      "id": "1ucio551tlv85l7moe5s",
      "merchant_id": "aucio551tlv85l7moe5g",
      "manufacturer": "dejavoo",
      "model": "z11",
      "serial_number": "1811000XXXX",
      "tpn": "1811000XXXX",
      "description": "front counter z11",
      "status": "active",
      "auth_key": "wcR1c9o1",
      "register_id": "1",
      "auto_settle": true,
      "settle_at": "00:00:00",
      "created_at": "2018-01-12T03:57:59Z",
      "updated_at": "0001-01-01T00:00:00Z"
    }
  ]
}

Use the returned id on a transaction request as payment_method.terminal.terminal_id. To manually settle a terminal's current batch, see Settlement batches.