Get a list of terminal products

get /merchants/{merchantId}/terminalProducts

Was this page helpful?

Returns a country-specific list of payment terminal packages and parts that the merchant account 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

Endpoint destination URL

https://management-test.adyen.com/v1/merchants/{merchantId}/terminalProducts

Query parameters

Required Optional

limit integer

The number of products to return.

offset integer

The number of products to skip.

terminalModelId string

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

country string Required

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

Path parameters

Required Optional

merchantId string Required

The unique identifier of the merchant account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
data array [object]

Terminal products that can be ordered.

Show children Hide children

description string

Information about items included and integration options.

id string

The unique identifier of the product.

itemsIncluded array [string]

A list of parts included in the terminal package.

name string

The descriptive name of the product.

price object

The price of the product.

Show children Hide children

currency string

The three-character ISO currency code.

value object

The price of the item.
204 - No Content

The request has been successfully processed, but there is no additional content.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error

The server could not process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of terminal products

Endpoint destination URL

Query parameters

Path parameters

Response parameters

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error