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

Allow your regular customers to save their information with the Customers model.This will prevent re-entering payment instrument information for recurring payments on your platform.Depending on the needs you can allow, creating, listing or deactivating payment instruments & creating, retrieving and updating customers.

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

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

This API exposes 5 operations across 4 paths, and defines 10 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.

5 operations 4 paths 10 schemas 1 DELETE2 GET1 POST1 PUT

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 Customers 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 5

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

Customers 5

Allow your regular customers to save their information with the Customers model. This will prevent re-entering payment instrument information for recurring payments on your platfo…

POST
/v0.1/customers
Create a customer
CreateCustomer body → 201400401403409
GET
/v0.1/customers/{customer_id}
Retrieve a customer
GetCustomer 1 param → 200401403404
PUT
/v0.1/customers/{customer_id}
Update a customer
UpdateCustomer 1 param body → 200401403404
GET
/v0.1/customers/{customer_id}/payment-instruments
List payment instruments
ListPaymentInstruments 1 param → 200401403404
DELETE
/v0.1/customers/{customer_id}/payment-instruments/{token}
Deactivate a payment instrument
DeactivatePaymentInstrument 2 params → 204400401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PersonalDetails (7 properties), PaymentInstrumentResponse (6 properties), AddressLegacy (6 properties), Problem (5 properties). Each schema is shown below with its type and property counts.

Error
object
Error message structure.
2 properties
ErrorExtended
Error payload with the invalid parameter reference.
Customer
object
Saved customer details.
2 properties 1 required
PaymentInstrumentResponse
object
Payment Instrument Response
6 properties
Problem
object
A RFC 9457 problem details object. Additional properties specific to the problem type may be present.
5 properties 1 required
PersonalDetails
object
Personal details for the customer.
7 properties
MandateResponse
object
Details of the mandate linked to the saved payment instrument.
3 properties
CardType
string
Issuing card network of the payment card used for the transaction.
ErrorForbidden
object
Error message for forbidden requests.
3 properties
AddressLegacy
object
Profile's personal address information.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sumup-customers-api-openapi.yml Raw ↑

Other APIs SumUp publishes across the network.

SumUp Checkouts API
SumUp Members API
SumUp Memberships API
SumUp Merchants 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 Customers 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.