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 Merchants API

Merchant account represents a single business entity at SumUp.

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

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

This API exposes 3 operations across 3 paths, and defines 22 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.

3 operations 3 paths 22 schemas 3 GET

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 Merchants 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Merchants 3

Merchant account represents a single business entity at SumUp.

GET
/v1/merchants/{merchant_code}
Retrieve a Merchant
GetMerchant 2 params → 200404
GET
/v1/merchants/{merchant_code}/persons
List Persons
ListPersons 2 params → 200404
GET
/v1/merchants/{merchant_code}/persons/{person_id}
Retrieve a Person
GetPerson 3 params → 200404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Address (17 properties), BasePerson (16 properties), Company (9 properties), Branding (8 properties). Each schema is shown below with its type and property counts.

LegalType
string
The unique legal type reference as defined in the country SDK. We do not rely on IDs as used by other services. Consumers of this API are expected to use the c…
Problem
object
A RFC 9457 problem details object. Additional properties specific to the problem type may be present.
5 properties 1 required
PhoneNumber
string
A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
ChangeStatus
string
Reflects the status of changes submitted through the PATCH endpoints for the merchant or persons. If some changes have not been applied yet, the status will be…
Company
object
Information about the company or business. This is legal information that is used for verification.
9 properties
Person
Merchant
CompanyIdentifier
object
2 properties 2 required
ClassicMerchantIdentifiers
object
1 property 1 required
Timestamps
object
2 properties 2 required
ListPersonsResponseBody
object
1 property 1 required
Address
object
An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, city is posttown. In the United St…
17 properties 1 required
Branding
object
Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products.
8 properties
BasePerson
object
Base schema for a person associated with a merchant. This can be a legal representative, business owner (ultimate beneficial owner), or an officer. A legal rep…
16 properties 1 required
Ownership
object
1 property 1 required
CountryCode
string
An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2) country code. This definition users oneOf with a two-character string type to allow for…
BusinessProfile
object
Business information about the merchant. This information will be visible to the merchant's customers.
7 properties
Version
string
The version of the resource. The version reflects a specific change submitted to the API via one of the PATCH endpoints.
Meta
object
A set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Warni…
PersonalIdentifier
object
2 properties 2 required
CompanyIdentifiers
array
A list of country-specific company identifiers.
Attributes
object
Object attributes that are modifiable only by SumUp applications.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sumup-merchants-api-openapi.yml Raw ↑

Other APIs SumUp publishes across the network.

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

This is an independent, third-party profile of SumUp Merchants 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.