Pair terminal

Initiates pairing with a terminal.

Depending on the merchant account configuration, when you add a terminal, you either need to request a pairing code or add a registration code. Some accounts may be configured to do both terminal setup options if the account is configured with multiple eligible gateways.

For more information on how to pair a terminal, see Pairing the terminal in Guides.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

<div style="display:none;">

Request parameters

• merchantId
• terminalName

Response parameters

• terminalName
• pairingCode
• expirationDate
• key

</div>

{
  "merchantId": "100039",
  "terminalName": "FrontDesk1"
}