Properties
| Name | Type | Description |
|---|---|---|
| companyAccount | string | 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 t |
| store | string | The store code of the store that you want to assign the terminals to. |
| terminals | array | 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","P40 |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AssignTerminalsRequest",
"title": "AssignTerminalsRequest",
"properties": {
"companyAccount": {
"description": "Your company account. To return terminals to the company inventory, specify only this parameter and the `terminals`.",
"type": "string"
},
"merchantAccount": {
"description": "Name of the merchant account. Specify this parameter to assign terminals to this merchant account or to a store under this merchant account.",
"type": "string"
},
"merchantInventory": {
"description": "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.\n\n- Set this to **true** to assign the terminals to the merchant inventory. This also means that the terminals cannot be boarded.\n\n- 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.",
"type": "boolean"
},
"store": {
"description": "The store code of the store that you want to assign the terminals to.",
"type": "string"
},
"terminals": {
"description": "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.\n\nFor example, `[\"V400m-324689776\",\"P400Plus-329127412\"]`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"companyAccount",
"terminals"
],
"type": "object"
}