Assign terminals

post /assignTerminals

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.

Endpoint destination URL

https://postfmapi-test.adyen.com/postfmapi/terminal/v1/assignTerminals
Click to copy

Request parameters

companyAccount string Required

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

merchantAccount string

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

merchantInventory boolean

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.

store string

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

terminals [string] array 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 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
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy