APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminal ordersTerminal orders company level

Get a list of terminal products

GET
/companies/{companyId}/terminalProducts

Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to.

To make this request, your API credential must have one of the following roles:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

Query Parameters

country*string

The country to return products for, in ISO 3166-1 alpha-2 format. For example, US

terminalModelId?string

The terminal model to return products for. Use the ID returned in the GET /terminalModels response. For example, Verifone.M400

offset?integer

The number of products to skip.

Formatint32
limit?integer

The number of products to return.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies/string/terminalProducts?country=string"

Example response with V400m products available in The Netherlands

{  "data": [    {      "id": "PART-620222-EU",      "name": "Receipt Roll",      "price": {        "currency": "EUR",        "value": 0      }    },    {      "id": "PART-175746-EU",      "name": "Adyen Test Card",      "price": {        "currency": "EUR",        "value": 0      }    },    {      "id": "PART-327486-EU",      "name": "Battery - V400m",      "price": {        "currency": "EUR",        "value": 0      }    },    {      "id": "PART-287001-EU",      "name": "Bluetooth Charging Base - V400m",      "price": {        "currency": "EUR",        "value": 0      }    },    {      "id": "PART-745984-EU",      "name": "Power Supply EU - V400m",      "price": {        "currency": "EUR",        "value": 0      }    },    {      "id": "TBOX-V400m-684-EU",      "name": "V400m Package",      "description": "Includes an EU Power Supply, SIM Card and battery",      "price": {        "currency": "EUR",        "value": 0      },      "itemsIncluded": [        "Receipt Roll",        "Terminal Device V400m EU/GB"      ]    }  ]}

Cancel an order POST

Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write 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).

Get a list of billing entities GET

Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write 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).