Retrieve list of POS equipment for merchant boarding

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get POS Equipment Catalog

Returns the catalog of Point-of-Sale (POS) terminal equipment available for merchant boarding within the authenticated ISO's configuration. Each entry contains an equipment ID, name, and description. These IDs are used in the equipmentId field when adding POS equipment to a merchant application. No query parameters are required — the catalog is automatically scoped to the ISO account.

Endpoint

GET /api/v1/equipment/pos

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Call this endpoint to populate a POS equipment selection list during merchant boarding or equipment management workflows. Always fetch the catalog before submitting POST /api/v1/equipment/equipmentpos to ensure the equipmentId you provide is valid for your ISO. The catalog may include a range of POS terminal models from manufacturers such as PAX, Dejavoo, ValorPOS, Verifone, and others supported by the platform.

Response

200 OK

FieldTypeDescription
dataarrayList of POS equipment catalog entries
data[].idintegerEquipment catalog ID to use in equipmentId when adding equipment
data[].namestringDisplay name of the POS equipment model
data[].descriptionstringDescription of the equipment's features or use case
statusstringHTTP status string (e.g., OK)
errorstringError message on failure; null on success
warningstringNon-fatal warning message, if any
validationResultsarrayValidation result objects, if any
requestIdintegerUnique request ID for tracking
{
  "data": [
    {
      "id": 14,
      "name": "PAX S300",
      "description": "Countertop PIN pad with EMV chip, NFC contactless, and magnetic stripe support"
    },
    {
      "id": 17,
      "name": "Dejavoo Z11",
      "description": "All-in-one wireless POS terminal with built-in printer and Wi-Fi/cellular connectivity"
    },
    {
      "id": 22,
      "name": "Valor VP550",
      "description": "Android-based smart terminal with touchscreen and integrated receipt printer"
    },
    {
      "id": 28,
      "name": "Verifone VX520",
      "description": "Standard countertop terminal with dial, Ethernet, and USB connectivity"
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 44871
}

Error Codes

CodeWhen it happens
401Invalid or missing Basic Auth credentials
403User does not have permission to access the POS equipment catalog
404No POS equipment is configured for this ISO account
500Internal server error while retrieving the equipment catalog

Common Mistakes

  • Using equipment IDs from this endpoint in the non-POS add endpoint (POST /api/v1/equipment/regular) — POS and non-POS catalogs are separate; only use IDs from this catalog in POST /api/v1/equipment/equipmentpos
  • Hard-coding equipment IDs across environments — IDs may differ between staging and production; always fetch the catalog at runtime
  • Assuming all terminal types listed in the TsysTerminal enum (for terminal boarding) have a corresponding catalog entry — the equipment catalog and the TSYS terminal type list serve different purposes

Related Endpoints

  • POST /api/v1/equipment/equipmentpos — add a POS equipment item from this catalog to a merchant application
  • GET /api/v1/equipment/regular — retrieve the non-POS peripheral equipment catalog
  • GET /api/v1/equipment/funders — retrieve the list of available funders for equipment financing
  • GET /api/v1/merchant/equipment — view equipment already assigned to a specific merchant

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/equipment/pos" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json