Update a Reader

PATCH/v0.1/merchants/{merchant_code}/readers/{reader_id}

Updates a reader's name or metadata and returns the updated reader.

Providing metadata replaces the entire metadata object; include all entries that should be retained. Omitted fields remain unchanged.

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

Required permissions:

readers.update

Authorization

Use one of the following alternatives:

apiKey
oauth2 with scopes readers.writeterminals.write

Authorization guide

Path parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"
reader_idstringrequired
minLength: 30maxLength: 30
The unique identifier of the reader.

Example: "rdr_3MSAFM23CK82VSTT4BN6RWSQ65"

Body parameters

application/jsonrequired

namestring
maxLength: 500
Custom human-readable, user-defined name for easier identification of the reader.

Example: "Frontdesk"
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: {}

Responses

200application/json

Returns the updated Reader object if the update succeeded.

idstringrequired
minLength: 30maxLength: 30
Unique identifier of the reader that the payment is initiated on.

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.

403application/problem+json

The request isn't sufficiently authorized to modify the reader.

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"

404application/problem+json

The requested Reader resource does not exist.

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"

PATCH

Code sample

curl --request PATCH \
  --url https://api.sumup.com/v0.1/merchants/MK10CL2A/readers/rdr_3MSAFM23CK82VSTT4BN6RWSQ65 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Frontdesk",
  "metadata": {}
}
'

import SumUp from "@sumup/sdk";

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

  const result = await client.readers.update(
    "MK10CL2A",
    "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.UpdateAsync(
            "your-merchant-code",
            "your-reader-id",
            new ReadersUpdateRequest
            {
                Metadata = new Metadata { },
                Name = "Frontdesk",
            });

        Console.WriteLine(response.StatusCode);
    }
}

import com.sumup.sdk.SumUpClient;

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

    var result = client.readers().update(
            "MK10CL2A",
            "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
            com.sumup.sdk.models.UpdateReaderRequest.builder()
                .build()
        );
    System.out.println(result);
  }
}

import os

import sumup

client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
result = client.readers.update(
    "MK10CL2A",
    "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
    name="Frontdesk",
    metadata={},
)
print(result)

<?php

declare(strict_types=1);

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

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

$body = [
    'metadata' => [],
    'name' => 'Frontdesk',
];

$result = $sumup->readers()->update(
    'MK10CL2A',
    'rdr_3MSAFM23CK82VSTT4BN6RWSQ65',
    $body,
);

var_dump($result);

package main

import (
	"context"
	"fmt"

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

func main() {
	client := sumup.NewClient()
	result, err := client.Readers.Update(context.TODO(), "MK10CL2A", "rdr_3MSAFM23CK82VSTT4BN6RWSQ65", sumup.ReadersUpdateParams{
		Metadata: sumup.Metadata{},
		Name:     new(sumup.ReaderName("Frontdesk")),
	})
	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 body = sumup::resources::readers::UpdateRequest::builder().build();
    let response = client
        .readers()
        .update("MERCHANT_CODE", "READER_ID", body)
        .await
        .expect("update request failed");
    println!("{response:#?}");
}

Response example

{
  "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/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "You do not have permission to perform this action."
}

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