SUsumup
Readers

Get Reader Settings

Changed on

Returns the menu lock settings for a Solo reader.

For an online reader, returns the current settings. For an offline reader, returns the last saved settings, which may differ from its current configuration. Returns 404 if the reader is offline and no saved settings are available.

The response may include the menu lock PIN.

get/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.read

Path parameters

merchant_codestring required

The merchant code of the account that owns the reader.

reader_idstring required

The unique identifier of the reader.

Response

Reader settings retrieved successfully.

Example response

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

Changes