Payrexx Octri Demo
POST/ecr/{serialNumber}/pair

Pair an ECR terminal

Pairs an ECR terminal with the merchant account. For NexGo terminals, provide the one-time pairingCode shown on the terminal; Newland terminals authorize automatically using the merchant's stored credentials. The response includes the terminal's pairing status and configuration.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
serialNumberstringrequired
The serial number of the ECR terminal to pair.

Optional pairing details for the ECR terminal.

cashierNamestringoptional
NexGo devices only — ignored for Newland devices.
Default:terminalName
pairingCodestringoptional
One-time pairing code shown on the terminal screen. Required for NexGo devices only — ignored for Newland devices, which authorize automatically using the merchant's stored credentials.

2 status codes
200Returns the terminal's pairing data, including cashier name, configuration, and pairing status.
dataobjectoptional
statusstringrequired
400Returned when the pairing request cannot be processed.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

A 400 is returned when the pairing request cannot be processed. For NexGo terminals, provide the pairingCode shown on the terminal; Newland terminals ignore this field. The serialNumber path parameter identifies the terminal to pair.