Get Terminal Information

Last updated: 2023-11-28

POST

/getTerminalInfo

Get filtered information about your terminal population

Request Body

customerIdnumberoptional

Customer ID. Can be found in the URL of the customer page: /OnBoarding/ModifyCustomer?id=%

storeIdstringoptional

Custom identifier used when on-boarding the store.

merchantIdstringoptional

ID of the specific merchant

lastTransactionTimestring (ISO 8601)optional

Filter terminals by last transaction date/time.

firstTransactionTimestring (ISO 8601)optional

Filter terminals by first transaction date/time.

modelstringoptional

Terminal model name (e.g., C100).

isActivebooleanoptional

Filter by terminal active status.

HTTP Status Code Summary

Code	Description
200	Terminal information retrieved successfully.
400	Bad request format or validation failed.
401	Unauthorized — missing or invalid authentication credentials.
404	No resources found for the provided filters.
422	Unprocessable entity — semantic errors in the request.

Request

cURL

1curl -X 'POST' \
2  'https://demo-api.westpay.se/access/v2/getTerminalInfo' \
3  -H 'accept: text/plain' \
4  -H 'Ocp-Apim-Subscription-Key: <merchant-subscription-key>' \
5  -H 'Authorization: Bearer <access-token>' \
6  -H 'Content-Type: application/json' \
7  -d '{
8  "customerId": 0,
9  "storeId": "string",
10  "merchantId: "string",
11  "lastTransactionTime": "2024-10-10T09:14:04.690Z",
12  "firstTransactionTime": "2024-10-10T09:14:04.690Z"
13  "model": "string",
14  "isActive": true,
15}'

Response

1{
2    "terminalInfo": [
3        {
4            "terminalId": "<filtered terminal id>",
5            "parentName": "<filtered parent name>",
6            "customerName": "<filtered customer name>",
7            "merchantAcquirerReference": "<filtered acquirer reference>",
8            "storeId": "<filtered store id>",
9            "ecrId": "<filtered ecr id>",
10            "serial": "<filtered serial>",
11            "model": "<filtered model>",
12            "paVersion": "<filtered pa version>",
13            "applicationMode": "<filtered application mode>",
14            "activatedTime": "<filtered activated time>",
15            "lastTransactionTime": "<filtered last transaction time>",
16            "currentParameters": "<filtered current parameters>",
17            "isDecommissioned": false,
18            "decommissionedTime": "<filtered decommissioned time>",
19            "isActive": true
20        }
21    ]
22}