Automate the management of your terminals

In your Customer Area, you can manually order, assign, and configure terminals, and schedule actions like installing Android apps. However, doing this manually can be too time-consuming or impractical.

To automate the management of terminals you can make API requests to order, assign, and configure terminals. Then, when the configured terminal is delivered to the store that it is assigned to, store staff only need to board the terminal. You can also schedule terminal actions through API.

API key and roles

Using Management API, you can order, assign, and configure terminals, and schedule terminal actions. To authenticate your requests, you need an API credential. This API credential must have an API key.

Your API credential must also have specific roles, depending on what you want to do.

Rate limits in the live environment

To ensure the stability of the live environment, we enforce rate limits on live Management API endpoints related to payment terminal management and stores. This means that when the number of requests you send exceeds a threshold within a time frame, additional requests are blocked until the time frame ends.

For example: if the rate limit is 160 requests per minute for a group of endpoints, things work as usual for the first 160 requests within the minute. But if you send another request to an endpoint in that same group in that same minute, the request fails. You need to wait until the minute ends before you retry the request.

When a Management API request fails due to exceeding a rate limit, the response includes "detail": "too many requests".

{
    "type": "https://docs.adyen.com/errors/internal",
    "title": "An internal error happened",
    "status": 500,
    "detail": "too many requests",
    "errorCode": "00_500"
}

Expand the following sections to see the rate limits per endpoint level. Note that these limits are indicative and can change as needed to maintain the stability of the live environment.

The live base URL for all these endpoints is https://management-live.adyen.com/v{version_number}.

What do you want to do?

Order terminals

Make API requests to order payment terminals and accessories.

Assign terminals

Make API requests to assign payment terminals to a store.

Configure terminals

Make API requests to configure payment terminals.

Schedule actions

Make API requests to schedule actions on terminals.