---
title: "Get Reader Settings"
method: GET
path: "/v0.1/merchants/{merchant_code}/readers/{reader_id}/settings"
tags: ["Readers"]
---

# Get Reader Settings

`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: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://api.sumup.com/authorize`
    - Token URL: `https://api.sumup.com/token` scopes: `readers.read`

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.

## Path parameters

- `merchant_code` string, required
- `reader_id` string, required

## Response `200`

Reader settings retrieved successfully.

- GetReaderSettingsResponse: Menu lock settings reported by the reader, or the last saved settings when offline.
  - `data` object, required
    - `menu_lock` object, required: Menu lock configuration. Fields may be absent if no value is available.
      - `enabled` boolean: Whether menu lock is enabled.
      - `passcode` string, password: Four-digit PIN used to unlock the reader's menu.

## Other responses

- `401`: Unauthorized
- `404`: The reader was not found, or it is offline and has no saved settings.
- `422`: The reader model is not supported, the firmware version is unsupported, or the reader could not return its settings.

## Changes

- **2026-11-03** `38138e18acd1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sumup/apis/sumup-rest-api/changes/v0.1/merchants/:merchant_code/readers/:reader_id/settings/get.md)

---

[API](https://skmtc.dev/sumup/apis/sumup-rest-api.md) - [All operations](https://skmtc.dev/sumup/apis/sumup-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sumup/apis/sumup-rest-api/revisions/38138e18acd1?raw)
