\n Assign terminals in the Customer Area\n <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/automating-terminal-management\/assign-terminals-api","articleFields":{"description":"Assign your terminals using our Management API.","robots":"noindex,nofollow"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/automating-terminal-management\/assign-terminals-api","title":"Assign terminals","content":"To enable taking payments on a payment terminal, the first step is to reassign the terminal from its initial account level and status to a level and status that allows boarding. Then the terminal needs to be boarded.\nYou can reassign your terminals manually in your Customer Area, but Management API enables you to automate the reassignment.\n\nSupport for the \"classic\" POS Terminal Management API has stopped. To automate assigning terminals, you must use Management API.\n\nRequirements\nBefore you begin, take into account the following requirements and limitations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nA point-of-sale integration with Adyen.\n\n\nAPI credentials\nYou must have an API credential with an API key and specific roles depending on the task. To get the store details: Management API\u2014Stores read or Management API\u2014Stores read and write To get the terminal details: Management API\u2014Terminal actions read To assign terminals: Management API\u2014Assign Terminal If you have a Terminal API integration with cloud-based communications, you can use the existing API key that you use for Terminal API requests.\n\n\nWebhooks\nSubscribe to Terminal assignment complete webhooks.\n\n\nLimitations\nRequests to live Management API endpoints related to assigning terminals are subject to rate limits.\n\n\n\nAccount level and status of terminals\nWhen (re)assigning terminals, you need to be aware of the following:\n\n\nA terminal is always assigned to a level in your account setup: Company account, merchant account, or store. Note that some account setups do not have a store level and instead use merchant accounts to represent stores.\n\n\nA terminal has a status:\n\ninventory: The terminal is in inventory and cannot process transactions.\nreassignmentInProgress: A request to change the assignment of the terminal is being processed.\ndeployed: The terminal has been reassigned and is ready for boarding.\nboarded: The terminal is boarded to a store, or to a merchant account representing a store, and can process transactions.\n\n\n\nA new terminal is pre-assigned to the company or merchant account that the terminal was ordered for, and has the inventory status. To be able to process transactions, you reassign the terminal to a store, and then board the terminal. Or in an account setup that uses merchant accounts to represent stores, your reassignment to a merchant account needs to explicitly take the terminal out of the inventory status, and then you board the terminal.\nGet a list of stores\nTo reassign terminals to a specific store, you need to know the ID of the store. To find the store ID:\n\n\nMake a GET \/merchants\/{merchantId}\/stores request, specifying path and query parameters:\n\n\n\nPath parameter\nRequired\nDescription\n\n\n\n\nmerchantId\n\nThe unique identifier of the merchant account.\n\n\n\n\n\n\nQuery parameter\nRequired\nDescription\n\n\n\n\n reference\n\nThe reference of the store.\n\n\n pageSize\n\nThe number of items to have on a page, maximum 100. The default is 10 items on a page.\n\n\n pageNumber\n\nThe number of the page to fetch.\n\n\n\n\n\n\nThe response returns a paginated list of stores for the specified merchant account.\n\n\nFrom the response, save the storeId of the store that you want to assign terminals to. You need to specify that ID when you assign terminals to that store.\n\n\n\n\n\nGet terminal details\nTo reassign a terminal, you need to know the ID of the terminal. To find the terminal ID and other details like the account level to which the terminal is currently assigned:\n\n\nMake a GET \/terminals request.\n\n\n\nThe response returns a paginated list of terminals that your API credential has access to.\n\n\nFrom the response, save the id of the terminal that you want to assign to a specific account level. The response returns the following details for each terminal:\n\n\n\nResponse parameter\nDescription\n\n\n\n\n assignment\nAn object with: companyId: the unique identifier of the company account to which terminal is assigned. merchantId: the unique identifier of the merchant account to which terminal is assigned. reassignmentTarget: indicates where the terminal is in the process of being reassigned to. status: the status of the reassignment. storeId: the unique identifier of the store to which the terminal is assigned. \n\n\n connectivity\nInformation about bluetooth, cellular, ethernet, and Wi-Fi connectivity for the terminal.\n\n\n firmwareVersion\nThe software release currently in use on the terminal.\n\n\n id\nThe unique identifier of the terminal.\n\n\n lastActivityAt\nThe date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.\n\n\n lastTransactionAt\nThe date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.\n\n\n model\nThe model name of the terminal.\n\n\n serialNumber\nThe serial number of the terminal.\n\n\n\n\n\n\n\n\nReassign terminals\nTo enable taking payments on a payment terminal, you need to reassign the terminal from its initial account level and status to a level and status that allows boarding. Then you need to board the terminal.\n\n\nPrepare for assigning terminals:\n\nMake sure you know the ID of the terminal that you want to reassign. See Get terminal details.\nIf you are going to reassign the terminal to a store, make sure you know the ID of the store. See Get a list of stores.\n\n\n\nMake a POST \/terminals\/{terminalId}\/reassign request, specifying path and request body parameters:\n\n\n\nPath parameter\nRequired\nDescription\n\n\n\n\nterminalId\n\nThe unique identifier of the payment terminal in the format [Device model]-[Serial number].\n\n\n\n\n\n\nBody parameter\nRequired\nDescription\n\n\n\n\ncompanyId\n\nThe unique identifier of the company account.\n\n\nmerchantId\n\nThe unique identifier of the merchant account. When reassigning terminals to a merchant account, you must also specify the inventory field.\n\n\ninventory\n\nRequired when reassigning a terminal to a merchant account. If true, the terminal is assigned to the inventory of the merchant account and cannot process transactions. If false, the terminal is taken out of the inventory and can be boarded. \n\n\nstoreId\n\nThe unique identifier of the store.\n\n\n\n\n\n\n\n\n\n\n\nCheck that the response returns HTTP status code 200\/OK. The request is processed asynchronously.\n\n\nWhen the terminal is online, it downloads and applies the new configuration. The terminal is then ready for boarding.\nTerminal assignment complete webhooks\nIn some cases, it is not possible to reassign a terminal immediately, and we schedule the assignment for later. To let you know when the reassignment is completed, we send you a terminalAssignment.completed webhook message. This is sent as an HTTP callback to your server.\nTo set up receiving these webhook messages, follow the general instructions to set up webhooks but select Terminal assignment complete (not Standard) as the webhook type you want to add.\nAfter you set up the webhook type, you will receive terminalAssignment.completed webhook messages with:\n\nThe account (assignedToAccount) or store (assignedToStore) that the terminal is assigned to.\nThe date and time when the assignment was carried out.\nThe ID of the terminal involved.\n\n{\n \"assignedToAccount\": \"ADYEN_MERCHANT_ACCOUNT\",\n \"assignedToStore\": \"YOUR_STORE\",\n \"eventDate\": \"2020-06-03 22:42:13.840 CEST\",\n \"pspReference\": \"NO_PSP_REF_1591216933840470\",\n \"uniqueTerminalId\": \"V400m-324689776\"\n}\nSee also\n\n\n Order terminals using API requests\n \n Configure terminals using API requests\n \n Board the terminal\n \n Determine point-of-sale account structure\n \n Assign terminals in the Customer Area\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Automate the management of your terminals","lvl3":"Assign terminals"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/automating-terminal-management","lvl3":"\/pt\/point-of-sale\/automating-terminal-management\/assign-terminals-api"},"levels":4,"category":"In-person payments","category_color":"green","tags":["Assign","terminals"]},"articleFiles":{"get-merchants-merchantid-stores-request-6098324906.js":"get-merchants-merchantid-stores-request-6098324906.js<\/p>","get-terminals-request-3274127653.js":"
get-terminals-request-3274127653.js<\/p>","reassign-a-terminal-to-your-merchant-account-8008961478.js":"
reassign-a-terminal-to-your-merchant-account-8008961478.js<\/p>","reassign-a-terminal-to-your-store-9521507125.js":"
reassign-a-terminal-to-your-store-9521507125.js<\/p>"}}
![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n