Get merchant terminals

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

Get Merchant Terminals

Retrieves all payment terminals registered under a specific merchant account. Each terminal record includes its internal identifier, display name, device type code, current status, and creation timestamp. Use this endpoint to enumerate terminal inventory before requesting VAR sheet data or when auditing a merchant's active equipment.

Endpoint

GET /api/export/Terminals

Authentication

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

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint as the first step in a terminal programming workflow — retrieve the list of terminals to obtain their internalId values, then pass each internalId to GET /api/export/Varsheet to fetch the full VAR sheet for that terminal. Also use it to audit which terminals are in New, Submitted, or Closed status for a given merchant.

Query Parameters

ParameterTypeRequiredDescription
idintegerYesThe internal merchant profile ID (integer)

Response

200 OK

Envelope fields:

FieldTypeDescription
requestIdintegerUnique identifier for this API request
successbooleanWhether the request was successful
errorstringError message if success is false
validationErrorsarrayField-level validation errors if applicable
dataarrayArray of terminal objects

Each terminal object in data:

FieldTypeDescription
internalIdintegerInternal terminal identifier (used as internalId in Varsheet call)
namestringDisplay name of the terminal
terminalTypeintegerDevice type code
statusstringTerminal status: New, Submitted, Changed, Closed, CloseTemporary, NotSubmitted
creationDatestring (ISO 8601)Date the terminal was created
{
  "requestId": 298741,
  "success": true,
  "error": null,
  "validationErrors": [],
  "data": [
    {
      "internalId": 10045,
      "name": "Front Counter Terminal",
      "terminalType": 3,
      "status": "Submitted",
      "creationDate": "2025-11-02T14:22:10Z"
    },
    {
      "internalId": 10046,
      "name": "Mobile POS Unit 1",
      "terminalType": 7,
      "status": "New",
      "creationDate": "2026-01-18T09:05:33Z"
    }
  ]
}

Error Codes

CodeWhen it happens
400Missing or malformed id parameter
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No merchant found for the provided id
500Internal server error

Common Mistakes

  • Using the public merchant ID string instead of the internal integer id.
  • Assuming an empty data array means the merchant does not exist — it may mean the merchant has no terminals provisioned yet.
  • Attempting to fetch a VAR sheet for a terminal with status: Closed — only active terminals have programmable VAR sheet parameters.
  • Confusing terminalType (an integer device code) with status when filtering results.

Related Endpoints

  • GET /api/export/Varsheet — fetch VAR sheet parameters for a specific terminal using internalId
  • GET /api/export/MerchantProfile — retrieve the full merchant record first to confirm the merchant id
  • GET /api/v2/export/MerchantProfile — v2 merchant profile endpoint

Example

curl -X GET "https://hq.staging.netevia.dev/api/export/Terminals?id=71103" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"
Query Params
int32
required
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