ManagementTerminals terminal level

Reassign a terminal

POST
/terminals/{terminalId}/reassign

Reassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store.

To make this request, your API credential must have the following role:

  • Management API—Assign Terminal

In the live environment, requests to this endpoint are subject to rate limits.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

terminalId*string

The unique identifier of the payment terminal.

Request Body

application/json

companyId?string

The unique identifier of the company account to which the terminal is reassigned.

inventory?boolean

Must be specified when reassigning terminals to a merchant account:

  • If set to true, reassigns terminals to the inventory of the merchant account and the terminals cannot process transactions.

  • If set to false, reassigns terminals directly to the merchant account and the terminals can process transactions.

merchantId?string

The unique identifier of the merchant account to which the terminal is reassigned. When reassigning terminals to a merchant account, you must specify the inventory field.

storeId?string

The unique identifier of the store to which the terminal is reassigned.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/terminals/string/reassign" \  -H "Content-Type: application/json" \  -d '{    "merchantId": "YOUR_MERCHANT_ID",    "inventory": false  }'
Empty