SUsumup
Readers

Update Reader Settings

Changed on

Updates the menu lock settings for a Solo reader. The reader must be online. A successful response confirms that the reader applied the update.

Include at least one of menu_lock.enabled or menu_lock.passcode. Omitted settings keep their current values. The response contains only the settings included in the request.

When enabling menu lock for a reader without a PIN, include a four-digit PIN in menu_lock.passcode in the same request.

patch/v0.1/merchants/{merchant_code}/readers/{reader_id}/settings

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/merchants/{merchant_code}/readers/{reader_id}/settings
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: readers.write

Path parameters

merchant_codestring required

The merchant code of the account that owns the reader.

reader_idstring required

The unique identifier of the reader.

Request body

Example request

{
  "menu_lock": {
    "enabled": true,
    "passcode": "1234"
  }
}

Response

Reader settings updated successfully.

Example response

{
  "data": {
    "menu_lock": {
      "enabled": true,
      "passcode": "1234"
    },
    "status": "applied"
  }
}

Changes