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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
terminals[] Array Yes

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"].

companyAccount String Yes

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

merchantAccount String No

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 No

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 No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.