How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SumUp Readers API

A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.

SumUp Readers API is one of 10 APIs that SumUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Readers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.sumup.com.

8 operations 5 paths 19 schemas 1 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.sumup.com
Authentication
HTTP Bearer, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

SumUp Readers API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (apiKey). It supports OAuth 2.0 (oauth2) using the authorizationCode and clientCredentials flows, exposing 8 scopes.

  • apiKey — API keys allow you easily interact with SumUp APIs. API keys are static tokens. You can create API keys from the [Dashboard](https://me.sumup.com/settings/api-…
  • oauth2 — SumUp supports [OAuth 2.0](https://tools.ietf.org/html/rfc6749) authentication for platforms that want to offer their services to SumUp users. To integrate via…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Readers 8

A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.

GET
/v0.1/merchants/{merchant_code}/readers
List Readers
ListReaders 1 param → 200401
POST
/v0.1/merchants/{merchant_code}/readers
Create a Reader
CreateReader 1 param body → 201400404409
GET
/v0.1/merchants/{merchant_code}/readers/{reader_id}
Retrieve a Reader
GetReader 3 params → 200404
DELETE
/v0.1/merchants/{merchant_code}/readers/{reader_id}
Delete a reader
DeleteReader 2 params → 200404
PATCH
/v0.1/merchants/{merchant_code}/readers/{reader_id}
Update a Reader
UpdateReader 2 params body → 200403404
POST
/v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout
Create a Reader Checkout
CreateReaderCheckout 2 params body → 201400401404422
GET
/v0.1/merchants/{merchant_code}/readers/{reader_id}/status
Get a Reader Status
GetReaderStatus 2 params → 200400401404
POST
/v0.1/merchants/{merchant_code}/readers/{reader_id}/terminate
Terminate a Reader Checkout
CreateReaderTerminate 2 params body → 202400401404422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are CreateReaderCheckoutRequest (9 properties), Reader (8 properties), Problem (5 properties), ReaderCheckoutStatusChange (4 properties). Each schema is shown below with its type and property counts.

ReaderStatus
string
The status of the reader object gives information about the current state of the reader. Possible values: - unknown - The reader status is unknown. - processin…
Problem
object
A RFC 9457 problem details object. Additional properties specific to the problem type may be present.
5 properties 1 required
NotFound
object
404 Not Found
1 property 1 required
CreateReaderCheckoutError
object
Error description
1 property 1 required
CreateReaderCheckoutResponse
object
1 property 1 required
ReaderID
string
Unique identifier of the object. Note that this identifies the instance of the physical devices pairing with your SumUp account. If you [delete](https://develo…
CreateReaderCheckoutUnprocessableEntity
object
Unprocessable entity
1 property 1 required
CreateReaderTerminateError
object
Error description
1 property 1 required
ReaderName
string
Custom human-readable, user-defined name for easier identification of the reader.
Unauthorized
object
401 Unauthorized
1 property 1 required
Reader
object
A physical card reader device that can accept in-person payments.
8 properties 6 required
ReaderPairingCode
string
The pairing code is a 8 or 9 character alphanumeric string that is displayed on a SumUp Device after initiating the pairing. It is used to link the physical de…
CreateReaderTerminateUnprocessableEntity
object
Unprocessable entity
1 property 1 required
Metadata
object
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 param…
BadRequest
object
400 Bad Request
1 property 1 required
ReaderDevice
object
Information about the underlying physical device.
2 properties 2 required
CreateReaderCheckoutRequest
object
Reader Checkout
9 properties 1 required
ReaderCheckoutStatusChange
object
The callback payload containing the status change of the Reader Checkout.
4 properties 4 required
StatusResponse
object
Status of a device
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sumup-readers-api-openapi.yml Raw ↑

Other APIs SumUp publishes across the network.

SumUp Checkouts API
SumUp Customers API
SumUp Members API
SumUp Memberships API
SumUp Merchants API
SumUp Payouts API
SumUp Receipts API
SumUp Roles API
SumUp Transactions API
Where this information came from

This is an independent, third-party profile of SumUp Readers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.