Get Reader Settings

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

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.

OAuth scopes: Requires one of: readers.read.

Required permissions:

readers.checkouts.view

Authorization

Use one of the following alternatives:

apiKey
oauth2 with scopes readers.read

Authorization guide

Path parameters

merchant_codestringrequired
The merchant code of the account that owns the reader.
reader_idstringrequired
The unique identifier of the reader.

Responses

200application/json

Reader settings retrieved successfully.

dataobjectrequired
Show 1 property
- menu_lockobjectrequired
  Menu lock configuration. Fields may be absent if no value is available.
  
  Show 2 properties
  enabledboolean
  Whether menu lock is enabled.
  
  Example: true
  passcodestring
  format: passwordpattern: ^[0-9]{4}$
  Four-digit PIN used to unlock the reader's menu.
  
  Example: "1234"

401application/json

Unauthorized

errorsobjectrequired
Show 2 properties
- detailstringrequired
  Error message
- typestring
  Error code

application/problem+json

typestringrequired
format: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestring
format: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

{
  "detail": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.sumup.com/problem/unauthorized"
}

404application/json

The reader was not found, or it is offline and has no saved settings.

errorsobjectrequired
Show 1 property
- detailstringrequired
  Fuller message giving context to error

application/problem+json

typestringrequired
format: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestring
format: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

{
  "detail": "The requested resource doesn't exist or does not belong to you.",
  "status": 404,
  "title": "Requested resource couldn't be found.",
  "type": "https://developer.sumup.com/problem/not-found"
}

422application/json

The reader model is not supported, or the reader could not return its settings.

errorsobjectrequired

application/problem+json

typestringrequired
format: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestring
format: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

{
  "detail": "Reader settings are only supported for Solo readers.",
  "status": 422,
  "title": "Unsupported Device Model",
  "type": "https://developer.sumup.com/problem/unsupported-device-model"
}

GET

Code sample

curl --request GET \
  --url https://api.sumup.com/v0.1/merchants/MC0X0ABC/readers/rdr_3MSAFM23CK82VSTT4BN6RWSQ65/settings \
  --header 'Authorization: Bearer <token>'

import SumUp from "@sumup/sdk";

async function main() {
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });

  const result = await client.readers.getReaderSettings(
    "MC0X0ABC",
    "rdr_3MSAFM23CK82VSTT4BN6RWSQ65"
  );
  console.log(result);
}

main().catch(console.error);

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Readers.GetReaderSettingsAsync(
            "your-merchant-code",
            "your-reader-id");

        Console.WriteLine(response.StatusCode);
    }
}

import com.sumup.sdk.SumUpClient;

public final class GetReaderSettingsSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    var result = client.readers().getReaderSettings(
            "MC0X0ABC",
            "rdr_3MSAFM23CK82VSTT4BN6RWSQ65"
        );
    System.out.println(result);
  }
}

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

$sumup = new \SumUp\SumUp('sup_sk_your_api_key');

$result = $sumup->readers()->getReaderSettings(
    'MC0X0ABC',
    'rdr_3MSAFM23CK82VSTT4BN6RWSQ65',
);

var_dump($result);

package main

import (
	"context"
	"fmt"

	"github.com/sumup/sumup-go"
)

func main() {
	client := sumup.NewClient()
	result, err := client.Readers.GetReaderSettings(context.TODO(), "MC0X0ABC", "rdr_3MSAFM23CK82VSTT4BN6RWSQ65")
	if err != nil {
		panic(err.Error())
	}

	fmt.Printf("%+v\n", result)
}

use sumup::{Authorization, Client};
#[tokio::main]
async fn main() {
    let client = Client::default()
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
    let response = client
        .readers()
        .get_reader_settings("MERCHANT_CODE", "READER_ID")
        .await
        .expect("get_reader_settings request failed");
    println!("{response:#?}");
}

Response example

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

{
  "errors": {
    "detail": "string",
    "type": "string"
  }
}

{
  "errors": {
    "detail": "Not Found"
  }
}

{
  "errors": {
    "detail": "Reader settings are only supported for Solo readers.",
    "type": "UNSUPPORTED_DEVICE_MODEL"
  }
}