Terminal Management

Last updated: 2023-11-28

The Terminal Management API provides endpoints to query terminal information, retrieve available software packages, and create or update terminal configurations. These APIs are designed for merchants who need programmatic control over their Westpay terminal fleet.

Overview

Terminal management operations allow you to:

  • Query terminal information — Filter and retrieve detailed information about your terminal population
  • Get available packages — List software packages available for specific terminal models
  • Create and update configurations — Apply software package updates to specific terminals by serial number

Authentication

All terminal management endpoints require both authentication headers:

bash
Authorization: Bearer <access-token>
Ocp-Apim-Subscription-Key: <merchant-subscription-key>

Base URL

EnvironmentBase URL
Demohttps://demo-api.westpay.se/access/v2
Productionhttps://api.westpay.se/access/v2

Available Endpoints

EndpointMethodDescription
/getTerminalInfoPOSTGet filtered terminal information
/terminal/getPackages/{customerId}/{model}GETGet available packages for a model
/terminal/createUpdatePOSTCreate or update terminal configurations