Retail

Deregister terminal

Removes a terminal's registration through the Nexio API.

<!-- theme: info -->

📘 Notes

  • In addition to this API, you can deregister a terminal directly within the gateway user interface.
  • You can only deregister terminals that have already been registered with Nexio.
  • You may need to deregister a terminal in situations such as when the terminal needs to be used with a different gateway account.

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 supports terminal registration.

<div style="display:none;">

Request parameters

  • terminalId

Response parameters

  • terminalRegistrationStatus
</div>
post/pay/v3/deregisterTerminal

Request body

terminalIdstring required

The Nexio terminal ID. Get this value from the View terminal list endpoint.

Example request

{
  "terminalId": "eyJtZXJjaGFudElkIjoiMTAxMDM5IiwiZ2F0ZXdheUxhYmVsIjoiLi4uMmUyMSwuLi41ZWU3IiwidGVybWluYWwiOnsiaWQiOiIxMWU5MDIxMGNmZTdmNmFlOWVkNWUwYTgiLCJsb2NhdGlvbklkIjoiMTFlOGNkNmE4YjQ0YzUzZWFkNmFkY2UxIn19"
}

Response

Success

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

The current registration status of the terminal.

random-4611765RandomNnnn — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.