---
title: "Pair terminal"
method: POST
path: "/pay/v3/pairTerminal"
tags: ["Retail"]
---

# Pair terminal

`POST /pay/v3/pairTerminal`

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](https://docs.nexiopay.com/reference/registerterminal). 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](https://docs.nexiopay.com/docs/configuring-your-terminal-for-usaepay#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](https://docs.nexiopay.com/docs/sandbox-environments).

<div style="display:none;">

## Request parameters
- merchantId
- terminalName

## Response parameters
- terminalName
- pairingCode
- expirationDate
- key

</div>

## Request body

- object
  - `merchantId` string, required — The Nexio merchant ID (MID) to associate with the terminal.
  - `terminalName` string — The name of the terminal.

## Response `200`

Success

- object
  - `terminalName` TerminalName — unresolved $ref
  - `pairingCode` string — The code used to pair a physical terminal to a payment platform. It is valid for 60 seconds after generation.
  - `expirationDate` string — The date and time at which the pairing code expires, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `key` string — [USAePay's](https://docs.nexiopay.com/docs/usaepay-integration-guide) unique identifier for an instance of a specific terminal paired to the platform.
  - `random-4611765` RandomNnnn — unresolved $ref

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)