APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminals terminal level

Get a list of terminals

GET
/terminals

Returns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have the following roles:

  • Management API — Terminal actions read

In the live environment, requests to this endpoint are subject to rate limits.

Authorization

AuthorizationBasic <token>

In: header

Query Parameters

searchQuery?string

Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.

otpQuery?string

Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.

countries?string

Returns terminals located in the countries specified by their two-letter country code.

merchantIds?string

Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.

storeIds?string

Returns terminals that are assigned to the stores specified by their unique store ID.

brandModels?string

Returns terminals of the models specified in the format brand.model.

pageNumber?integer

The number of the page to fetch.

Formatint32
pageSize?integer

The number of items to have on a page, maximum 100. The default is 20 items on a page.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/terminals"

Example response when getting terminals that your API credential has access to.

{  "_links": {    "first": {      "href": "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"    },    "last": {      "href": "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"    },    "next": {      "href": "https://management-test.adyen.com/v3/terminals?pageNumber=1&pageSize=20"    },    "self": {      "href": "https://management-test.adyen.com/v3/terminals?pageNumber=0&pageSize=20"    }  },  "itemsTotal": 1,  "pagesTotal": 1,  "data": [    {      "id": "AMS1-000150183300032",      "model": "AMS1",      "serialNumber": "000150183300032",      "firmwareVersion": "Castles_Android 1.89.4",      "assignment": {        "companyId": "YOUR_COMPANY_ACCOUNT",        "merchantId": "YOUR_MERCHANT_ACCOUNT",        "storeId": "YOUR_STORE_ID",        "status": "reassignmentInProgress",        "reassignmentTarget": {          "inventory": true        }      },      "connectivity": {        "cellular": {          "iccid": "6006491286999921374"        },        "wifi": {          "ipAddress": "198.51.100.1",          "macAddress": "C4:6E:33:26:36:E4"        }      }    }  ]}

Get Apple Pay domains GET

Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read

Reassign a terminal POST

Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Assign Terminal In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).