Sign in

v1

latestOpenAPI 3.1.02026-07-1451432.5 KB
General

Assign terminals

Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.

post/assignTerminals

Request body

companyAccountstring required

Your company account. To return terminals to the company inventory, specify only this parameter and the terminals.

merchantAccountstring

Name of the merchant account. Specify this parameter to assign terminals to this merchant account or to a store under this merchant account.

merchantInventoryboolean

Boolean that indicates if you are assigning the terminals to the merchant inventory. Do not use when assigning terminals to a store. Required when assigning the terminal to a merchant account.

  • Set this to true to assign the terminals to the merchant inventory. This also means that the terminals cannot be boarded.

  • Set this to false to assign the terminals to the merchant account as in-store terminals. This makes the terminals ready to be boarded and to process payments through the specified merchant account.

storestring

The store code of the store that you want to assign the terminals to.

terminalsstring[] required

Array containing a list of terminal IDs that you want to assign or reassign to the merchant account or store, or that you want to return to the company inventory.

For example, ["V400m-324689776","P400Plus-329127412"].

Response

OK - the request has succeeded.

resultsobject required

Array that returns a list of the terminals, and for each terminal the result of assigning it to an account or store.

The results can be:

  • Done: The terminal has been assigned.

  • AssignmentScheduled: The terminal will be assigned asynschronously.

  • RemoveConfigScheduled: The terminal was previously assigned and boarded. Wait for the terminal to synchronize with the Adyen platform. For more information, refer to Reassigning boarded terminals.

  • Error: There was an error when assigning the terminal.

All 5 operations