API Reference

Register terminal

post
https://api.nexiopaysandbox.com/pay/v3/registerTerminal

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.

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.

Request parameters

  • merchantId
  • terminalRegistrationCode
  • terminalName

Response parameters

  • terminalName
  • deviceId
  • terminalSerialNumber
  • terminalRegistrationStatus
  • terminalId
Body Params
string
required

The Nexio merchant ID (MID) to associate with the terminal.

string
required

The registration code given by the terminal.

string
length ≤ 20

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.

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago