List Readers

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

List all readers of the merchant.

OAuth scopes: Requires one of: readers.read, terminals.read.

Required permissions:

readers.list

Authorization

Use one of the following alternatives:

apiKey
oauth2 with scopes readers.readterminals.read

Authorization guide

Path parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"

Responses

200application/json

Returns a list Reader objects.

itemsarray<object>required
Show 8 properties
- idstringrequired
  minLength: 30maxLength: 30
  Unique identifier of the object.
  
  Note that this identifies the instance of the physical devices pairing with your SumUp account. If you delete a reader, and pair the device again, the ID will be different. Do not use this ID to refer to a physical device.
  
  Example: "rdr_3MSAFM23CK82VSTT4BN6RWSQ65"
- namestringrequired
  maxLength: 500
  Custom human-readable, user-defined name for easier identification of the reader.
  
  Example: "Frontdesk"
- statusstringrequired
  Options:"unknown""processing""paired""expired"
  The status of the reader object gives information about the current state of the reader.
  
  Possible values:
  
  unknown - The reader status is unknown.
  
  processing - The reader is created and waits for the physical device to confirm the pairing.
  
  paired - The reader is paired with a merchant account and can be used with SumUp APIs.
  
  expired - The pairing is expired and no longer usable with the account. The resource needs to get recreated.
  
  Example: "paired"
- deviceobjectrequired
  Information about the underlying physical device.
  
  Show 2 properties
  identifierstringrequired
  A unique identifier of the physical device (e.g. serial number).
  
  Example: "U1DT3NA00-CN"
  modelstringrequired
  Options:"solo""virtual-solo"
  Identifier of the model of the device.
  
  Example: "solo"
- created_atstringrequired
  format: date-time
  The timestamp of when the reader was created.
  
  Example: "2023-01-18T15:16:17Z"
- updated_atstringrequired
  format: date-time
  The timestamp of when the reader was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- metadataobject
  Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
  
  Example: {}
- service_account_idstring
  format: uuid
  Identifier of the system-managed service account associated with this reader. Present only for readers that are already paired. This field is currently in beta and may change.

401application/problem+json

Authentication failed or missing required scope.

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.

GET

Code sample

curl --request GET \
  --url https://api.sumup.com/v0.1/merchants/MK10CL2A/readers \
  --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.list(
    "MK10CL2A"
  );
  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.ListAsync(
            "your-merchant-code");

        Console.WriteLine(response.StatusCode);
    }
}

import com.sumup.sdk.SumUpClient;

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

    var result = client.readers().list(
            "MK10CL2A"
        );
    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()->list(
    'MK10CL2A',
);

var_dump($result);

package main

import (
	"context"
	"fmt"

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

func main() {
	client := sumup.NewClient()
	result, err := client.Readers.List(context.TODO(), "MK10CL2A")
	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()
        .list("MERCHANT_CODE")
        .await
        .expect("list request failed");
    println!("{response:#?}");
}

Response example

{
  "items": [
    {
      "id": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
      "name": "Frontdesk",
      "status": "paired",
      "device": {
        "identifier": "U1DT3NA00-CN",
        "model": "solo"
      },
      "metadata": {},
      "service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
      "created_at": "2023-01-18T15:16:17Z",
      "updated_at": "2023-01-20T15:16:17Z"
    }
  ]
}

{
  "type": "https://developer.sumup.com/problem/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials are missing or invalid."
}