Sign in
Retail

Register terminal

Provides a registration (or activation) code from a terminal to Nexio's API in order to register the terminal with the appropriate gateway.

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

If you are unsure which endpoint to use, please contact Support.

For a tutorial on how to use this endpoint, see the Registering and deregistering terminals topic 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 and you must have an account with a gateway that requires terminal registration.

<div style="display:none;">

Request parameters

  • merchantId
  • terminalRegistrationCode
  • terminalName

Response parameters

  • terminalName
  • deviceId
  • terminalSerialNumber
  • terminalRegistrationStatus
  • terminalId
</div>
post/pay/v3/registerTerminal

Request body

merchantIdMerchantId required— unresolved $ref
terminalRegistrationCodestring required

The registration code given by the terminal.

terminalNamestring

The name to identify the terminal. This nickname is especially useful in situations where the account has more than one terminal. The value can be up to 20 alphanumeric characters. The system ignores special characters.

Response

Success

terminalIdstring

The Nexio ID for the terminal. Use this value when processing a retail terminal transaction.

terminalSerialNumberstring

The terminal serial number retrieved from the device during registration.

terminalRegistrationStatus'registered' | 'pending' | 'failed'

The current registration status of the terminal.

terminalNamestring

The nickname provided, if any, for identification of the terminal. This nickname is especially useful in situations where the account has more than one terminal.

deviceIdstring

If returned from the gateway, specifies the ID of the terminal device.

random-4611765RandomNnnn — unresolved $ref

Changes