{"title":"Automate the management of your terminals","category":"default","creationDate":1619007600,"content":"

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

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<\/a>. You can also schedule terminal actions through API.<\/p>\n

API key and roles<\/h2>\n

Using Management API<\/a>, you can order, assign, and configure terminals, and schedule terminal actions. To authenticate your requests, you need an API credential<\/a>. This API credential must have an API key<\/a>.<\/p>\n

\n

If you are using a Terminal API integration with cloud-based communications<\/a>, you can use the existing API key that you use for Terminal API requests.<\/p>\n<\/div>\n

Your API credential must also have specific roles<\/a>, depending on what you want to do.<\/p>\n\n\n\n\n\n\n\n\n
Task<\/th>\nRoles<\/th>\n<\/tr>\n<\/thead>\n
Order terminals<\/td>\nManagement API\u2014Terminal ordering read
Management API\u2014Terminal ordering read and write<\/td>\n<\/tr>\n
Assign terminals<\/td>\nManagement API\u2014Stores read
Management API\u2014Stores read and write<\/td>\n<\/tr>\n
Configure terminals<\/td>\nManagement API\u2014Terminal settings read
Management API\u2014Terminal settings read and write
Management API\u2014Terminal settings Advanced read and write<\/td>\n<\/tr>\n
Schedule terminal actions<\/td>\nManagement API\u2014Terminal actions read
Management API\u2014Terminal actions read and write<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Rate limits in the live environment<\/h2>\n

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.<\/p>\n

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.<\/p>\n

When a Management API request fails due to exceeding a rate limit, the response includes \"detail\": \"too many requests\"<\/code>.<\/p>\n

{\n    \"type\": \"https:\/\/docs.adyen.com\/errors\/internal\",\n    \"title\": \"An internal error happened\",\n    \"status\": 500,\n    \"detail\": \"too many requests\",\n    \"errorCode\": \"00_500\"\n}<\/code><\/pre>\n
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.<\/p>\n
The live base URL for all these endpoints is https:\/\/management-live.adyen.com\/v{version_number}<\/code>.<\/p>\n
\n    \n    
\n        
\n            <\/i>\n            
\n                                    
Company endpoints and rate limits<\/h3>\n                            <\/div>\n        <\/div>\n        
\n            \n\n
Total 160 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Upload Android app<\/td>POST  \/companies\/{companyId}\/androidApps<\/a><\/td><\/tr>\n
Upload Android certificate<\/td>POST  \/companies\/{companyId}\/androidCertificates<\/a><\/td><\/tr>\n<\/table>\n\n
Total 2000 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Get a list of Android apps<\/td>GET  \/companies\/{companyId}\/androidApps<\/a><\/td><\/tr>\n
Get an Android app<\/td>GET  \/companies\/{companyId}\/androidApps\/{id}<\/a><\/td><\/tr>\n
Reprocess an Android app<\/td>PATCH  \/companies\/{companyId}\/androidApps\/{id}<\/a><\/td><\/tr>\n
Get a list of Android certificates<\/td>GET  \/companies\/{companyId}\/androidCertificates<\/a><\/td><\/tr>\n
Get a list of billing entities<\/td>GET  \/companies\/{companyId}\/billingEntities<\/a><\/td><\/tr>\n
Get a list of shipping locations<\/td>GET  \/companies\/{companyId}\/shippingLocations<\/a><\/td><\/tr>\n
Create a shipping location<\/td>POST  \/companies\/{companyId}\/shippingLocations<\/a><\/td><\/tr>\n
Get a list of terminal actions<\/td>GET  \/companies\/{companyId}\/terminalActions<\/a><\/td><\/tr>\n
Get a terminal action<\/td>GET  \/companies\/{companyId}\/terminalActions\/{actionId}<\/a><\/td><\/tr>\n
Get the terminal logo<\/td>GET  \/companies\/{companyId}\/terminalLogos<\/a><\/td><\/tr>\n
Update the terminal logo<\/td>PATCH  \/companies\/{companyId}\/terminalLogos<\/a><\/td><\/tr>\n
Get a list of terminal models<\/td>GET  \/companies\/{companyId}\/terminalModels<\/a><\/td><\/tr>\n
Get a list of orders<\/td>GET  \/companies\/{companyId}\/terminalOrders<\/a><\/td><\/tr>\n
Create an order<\/td>POST  \/companies\/{companyId}\/terminalOrders<\/a><\/td><\/tr>\n
Get an order<\/td>GET  \/companies\/{companyId}\/terminalOrders\/{orderId}<\/a><\/td><\/tr>\n
Update an order<\/td>PATCH  \/companies\/{companyId}\/terminalOrders\/{orderId}<\/a><\/td><\/tr>\n
Cancel an order<\/td>POST  \/companies\/{companyId}\/terminalOrders\/{orderId}\/cancel<\/a><\/td><\/tr>\n
Get a list of terminal products<\/td>GET  \/companies\/{companyId}\/terminalProducts<\/a><\/td><\/tr>\n
Get terminal settings<\/td>GET  \/companies\/{companyId}\/terminalSettings<\/a><\/td><\/tr>\n
Update terminal settings<\/td>PATCH  \/companies\/{companyId}\/terminalSettings<\/a><\/td><\/tr>\n<\/table>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n
\n    \n    
\n        
\n            <\/i>\n            
\n                                    
Merchant endpoints and rate limits<\/h3>\n                            <\/div>\n        <\/div>\n        
\n            \n\n
Total 160 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Create a store<\/td>POST  \/merchants\/{merchantId}\/stores<\/a><\/td><\/tr>\n
Update a store<\/td>PATCH  \/merchants\/{merchantId}\/stores\/{storeId}<\/a><\/td><\/tr>\n<\/table>\n\n
Total 2000 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Get a list of billing entities<\/td>GET  \/merchants\/{merchantId}\/billingEntities<\/a><\/td><\/tr>\n
Get a list of shipping locations<\/td>GET  \/merchants\/{merchantId}\/shippingLocations<\/a><\/td><\/tr>\n
Create a shipping location<\/td>POST  \/merchants\/{merchantId}\/shippingLocations<\/a><\/td><\/tr>\n
Get a list of stores<\/td>GET  \/merchants\/{merchantId}\/stores<\/a><\/td><\/tr>\n
Get a store<\/td>GET  \/merchants\/{merchantId}\/stores\/{storeId}<\/a><\/td><\/tr>\n
Get the terminal logo<\/td>GET  \/merchants\/{merchantId}\/terminalLogos<\/a> 
 GET  \/merchants\/{merchantId}\/stores\/{reference}\/terminalLogos<\/a> <\/td><\/tr>\n
Update the terminal logo<\/td>PATCH  \/merchants\/{merchantId}\/terminalLogos<\/a> 
 PATCH  \/merchants\/{merchantId}\/stores\/{reference}\/terminalLogos<\/a> <\/td><\/tr>\n
Get a list of terminal models<\/td>GET  \/merchants\/{merchantId}\/terminalModels<\/a><\/td><\/tr>\n
Get a list of orders<\/td>GET  \/merchants\/{merchantId}\/terminalOrders<\/a><\/td><\/tr>\n
Create an order<\/td>POST  \/merchants\/{merchantId}\/terminalOrders<\/a><\/td><\/tr>\n
Get an order<\/td>GET  \/merchants\/{merchantId}\/terminalOrders\/{orderId}<\/a><\/td><\/tr>\n
Update an order<\/td>PATCH  \/merchants\/{merchantId}\/terminalOrders\/{orderId}<\/a><\/td><\/tr>\n
Cancel an order<\/td>POST  \/merchants\/{merchantId}\/terminalOrders\/{orderId}\/cancel<\/a><\/td><\/tr>\n
Get a list of terminal products<\/td>GET  \/merchants\/{merchantId}\/terminalProducts<\/a><\/td><\/tr>\n
Get terminal settings<\/td>GET  \/merchants\/{merchantId}\/terminalSettings<\/a> 
 GET  \/merchants\/{merchantId}\/stores\/{reference}\/terminalSettings<\/a><\/td><\/tr>\n
Update terminal settings<\/td>PATCH  \/merchants\/{merchantId}\/terminalSettings<\/a> 
 PATCH  \/merchants\/{merchantId}\/stores\/{reference}\/terminalSettings<\/a><\/td><\/tr>\n<\/table>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n
\n    \n    
\n        
\n            <\/i>\n            
\n                                    
Store endpoints and rate limits<\/h3>\n                            <\/div>\n        <\/div>\n        
\n            \n\n
Total 160 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Create a store<\/td>POST  \/stores<\/a><\/td><\/tr>\n
Update a store<\/td>PATCH  \/stores\/{storeId}<\/a><\/td><\/tr>\n
Update the terminal logo<\/td>PATCH  \/stores\/{storeId}\/terminalLogos<\/a><\/td><\/tr>\n<\/table>\n\n
Total 2000 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Get a list of stores<\/td>GET  \/stores<\/a><\/td><\/tr>\n
Get a store<\/td>GET  \/stores\/{storeId}<\/a><\/td><\/tr>\n
Get the terminal logo<\/td>GET  \/stores\/{storeId}\/terminalLogos<\/a><\/td><\/tr>\n
Get terminal settings<\/td>GET  \/stores\/{storeId}\/terminalSettings<\/a><\/td><\/tr>\n
Update terminal settings<\/td>PATCH  \/stores\/{storeId}\/terminalSettings<\/a><\/td><\/tr>\n<\/table>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n
\n    \n    
\n        
\n            <\/i>\n            
\n                                    
Terminal endpoints and rate limits<\/h3>\n                            <\/div>\n        <\/div>\n        
\n            \n\n
160 requests\/minute rate limit for the following endpoint<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Reassign a terminal<\/td>POST  \/terminals\/{terminalId}\/reassign<\/a><\/td><\/tr>\n<\/table>\n\n
Total 2000 requests\/minute rate limit for the following endpoints combined<\/th><\/tr>\n
Action<\/b><\/td>Endpoint<\/b><\/td><\/tr>\n
Get a list of terminals<\/td>GET  \/terminals<\/a><\/td><\/tr>\n
Create a terminal action<\/td>POST  \/terminals\/scheduleActions<\/a><\/td><\/tr>\n
Get the terminal logo<\/td>GET  \/terminals\/{terminalId}\/terminalLogos<\/a><\/td><\/tr>\n
Update the terminal logo<\/td>PATCH  \/terminals\/{terminalId}\/terminalLogos<\/a><\/td><\/tr>\n
Get terminal settings<\/td>GET  \/terminals\/{terminalId}\/terminalSettings<\/a><\/td><\/tr>\n
Update terminal settings<\/td>PATCH  \/terminals\/{terminalId}\/terminalSettings<\/a><\/td><\/tr>\n<\/table>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n
What do you want to do?<\/h2>\n
\n
Order terminals<\/h6>
Make API requests to order payment terminals and accessories.<\/p><\/div><\/p><\/a>
Assign terminals<\/h6>
Make API requests to assign payment terminals to a store.<\/p><\/div><\/p><\/a>
Configure terminals<\/h6>
Make API requests to configure payment terminals.<\/p><\/div><\/p><\/a>
Schedule actions<\/h6>
Make API requests to schedule actions on terminals.<\/p><\/div><\/p><\/a><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/automating-terminal-management","articleFields":{"description":"Use APIs to order, assign, and configure payment terminals.","feedback_component":true,"last_edit_on":"21-04-2021 14:23","robots":"noindex,nofollow"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/automating-terminal-management","title":"Automate the management of your terminals","content":"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.\nTo 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.\nAPI key and roles\nUsing  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.\n\nIf you are using a Terminal API integration with cloud-based communications, you can use the existing API key that you use for Terminal API requests.\n\nYour API credential must also have specific roles, depending on what you want to do.\n\n\n\nTask\nRoles\n\n\n\n\nOrder terminals\nManagement API\u2014Terminal ordering read  Management API\u2014Terminal ordering read and write\n\n\nAssign terminals\nManagement API\u2014Stores read  Management API\u2014Stores read and write\n\n\nConfigure terminals\nManagement API\u2014Terminal settings read  Management API\u2014Terminal settings read and write  Management API\u2014Terminal settings Advanced read and write\n\n\nSchedule terminal actions\nManagement API\u2014Terminal actions read  Management API\u2014Terminal actions read and write\n\n\n\nRate limits in the live environment\nTo 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.\nFor 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.\nWhen a Management API request fails due to exceeding a rate limit, the response includes \"detail\": \"too many requests\".\n{\n    \"type\": \"https:\/\/docs.adyen.com\/errors\/internal\",\n    \"title\": \"An internal error happened\",\n    \"status\": 500,\n    \"detail\": \"too many requests\",\n    \"errorCode\": \"00_500\"\n}\nExpand 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.\nThe live base URL for all these endpoints is https:\/\/management-live.adyen.com\/v{version_number}.\n\n    \n    \n        \n            \n            \n                                    Company endpoints and rate limits\n                            \n        \n        \n            \n\nTotal 160 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nUpload Android appPOST  \/companies\/{companyId}\/androidApps\nUpload Android certificatePOST  \/companies\/{companyId}\/androidCertificates\n\n\nTotal 2000 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nGet a list of Android appsGET  \/companies\/{companyId}\/androidApps\nGet an Android appGET  \/companies\/{companyId}\/androidApps\/{id}\nReprocess an Android appPATCH  \/companies\/{companyId}\/androidApps\/{id}\nGet a list of Android certificatesGET  \/companies\/{companyId}\/androidCertificates\nGet a list of billing entitiesGET  \/companies\/{companyId}\/billingEntities\nGet a list of shipping locationsGET  \/companies\/{companyId}\/shippingLocations\nCreate a shipping locationPOST  \/companies\/{companyId}\/shippingLocations\nGet a list of terminal actionsGET  \/companies\/{companyId}\/terminalActions\nGet a terminal actionGET  \/companies\/{companyId}\/terminalActions\/{actionId}\nGet the terminal logoGET  \/companies\/{companyId}\/terminalLogos\nUpdate the terminal logoPATCH  \/companies\/{companyId}\/terminalLogos\nGet a list of terminal modelsGET  \/companies\/{companyId}\/terminalModels\nGet a list of ordersGET  \/companies\/{companyId}\/terminalOrders\nCreate an orderPOST  \/companies\/{companyId}\/terminalOrders\nGet an orderGET  \/companies\/{companyId}\/terminalOrders\/{orderId}\nUpdate an orderPATCH  \/companies\/{companyId}\/terminalOrders\/{orderId}\nCancel an orderPOST  \/companies\/{companyId}\/terminalOrders\/{orderId}\/cancel\nGet a list of terminal productsGET  \/companies\/{companyId}\/terminalProducts\nGet terminal settingsGET  \/companies\/{companyId}\/terminalSettings\nUpdate terminal settingsPATCH  \/companies\/{companyId}\/terminalSettings\n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Merchant endpoints and rate limits\n                            \n        \n        \n            \n\nTotal 160 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nCreate a storePOST  \/merchants\/{merchantId}\/stores\nUpdate a storePATCH  \/merchants\/{merchantId}\/stores\/{storeId}\n\n\nTotal 2000 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nGet a list of billing entitiesGET  \/merchants\/{merchantId}\/billingEntities\nGet a list of shipping locationsGET  \/merchants\/{merchantId}\/shippingLocations\nCreate a shipping locationPOST  \/merchants\/{merchantId}\/shippingLocations\nGet a list of storesGET  \/merchants\/{merchantId}\/stores\nGet a storeGET  \/merchants\/{merchantId}\/stores\/{storeId}\nGet the terminal logoGET  \/merchants\/{merchantId}\/terminalLogos  GET  \/merchants\/{merchantId}\/stores\/{reference}\/terminalLogos \nUpdate the terminal logoPATCH  \/merchants\/{merchantId}\/terminalLogos  PATCH  \/merchants\/{merchantId}\/stores\/{reference}\/terminalLogos \nGet a list of terminal modelsGET  \/merchants\/{merchantId}\/terminalModels\nGet a list of ordersGET  \/merchants\/{merchantId}\/terminalOrders\nCreate an orderPOST  \/merchants\/{merchantId}\/terminalOrders\nGet an orderGET  \/merchants\/{merchantId}\/terminalOrders\/{orderId}\nUpdate an orderPATCH  \/merchants\/{merchantId}\/terminalOrders\/{orderId}\nCancel an orderPOST  \/merchants\/{merchantId}\/terminalOrders\/{orderId}\/cancel\nGet a list of terminal productsGET  \/merchants\/{merchantId}\/terminalProducts\nGet terminal settingsGET  \/merchants\/{merchantId}\/terminalSettings  GET  \/merchants\/{merchantId}\/stores\/{reference}\/terminalSettings\nUpdate terminal settingsPATCH  \/merchants\/{merchantId}\/terminalSettings  PATCH  \/merchants\/{merchantId}\/stores\/{reference}\/terminalSettings\n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Store endpoints and rate limits\n                            \n        \n        \n            \n\nTotal 160 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nCreate a storePOST  \/stores\nUpdate a storePATCH  \/stores\/{storeId}\nUpdate the terminal logoPATCH  \/stores\/{storeId}\/terminalLogos\n\n\nTotal 2000 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nGet a list of storesGET  \/stores\nGet a storeGET  \/stores\/{storeId}\nGet the terminal logoGET  \/stores\/{storeId}\/terminalLogos\nGet terminal settingsGET  \/stores\/{storeId}\/terminalSettings\nUpdate terminal settingsPATCH  \/stores\/{storeId}\/terminalSettings\n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Terminal endpoints and rate limits\n                            \n        \n        \n            \n\n160 requests\/minute rate limit for the following endpoint\nActionEndpoint\nReassign a terminalPOST  \/terminals\/{terminalId}\/reassign\n\n\nTotal 2000 requests\/minute rate limit for the following endpoints combined\nActionEndpoint\nGet a list of terminalsGET  \/terminals\nCreate a terminal actionPOST  \/terminals\/scheduleActions\nGet the terminal logoGET  \/terminals\/{terminalId}\/terminalLogos\nUpdate the terminal logoPATCH  \/terminals\/{terminalId}\/terminalLogos\nGet terminal settingsGET  \/terminals\/{terminalId}\/terminalSettings\nUpdate terminal settingsPATCH  \/terminals\/{terminalId}\/terminalSettings\n\n\n        \n    \n\n\nWhat do you want to do?\n\nOrder terminalsMake API requests to order payment terminals and accessories.Assign terminalsMake API requests to assign payment terminals to a store.Configure terminalsMake API requests to configure payment terminals.Schedule actionsMake API requests to schedule actions on terminals.\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Automate the management of your terminals"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"\/pt\/point-of-sale\/automating-terminal-management"},"levels":3,"category":"In-person payments","category_color":"green","tags":["Automate","management","terminals"]}}