SumUp website screenshot

SumUp

European mobile payment and POS platform with REST APIs for creating checkout links, managing card readers, processing payments, tracking transactions, and accessing payout data. SumUp serves over 4 million merchants in 37 markets with built-in fraud protection, sandbox environments for testing, and SDKs for multiple programming languages.

SumUp publishes 10 APIs on the APIs.io network, including Checkouts API, Customers API, Members API, and 7 more. Tagged areas include Payments, POS, Point of Sale, Card Readers, and Checkout.

The SumUp catalog on APIs.io includes 1 Spectral governance ruleset.

SumUp’s developer surface includes authentication, documentation, engineering blog, pricing, changelog, and 13 more developer resources.

49.9/100 developing ▼ -6.1 Agent 44/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessPaidSelf serve
10 APIs
PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 49.9/100 · developing
Contract Quality 14.8 / 25
Developer Ergonomics 4.3 / 20
Commercial Clarity 10.0 / 20
Operational Transparency 7.5 / 13
Governance 7.0 / 12
Discoverability 7.4 / 10
Agent readiness — 44/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/sumup: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 10

Individual APIs this provider publishes, each with its own machine-readable definition.

SumUp Checkouts API

Checkouts represent online payment sessions that you create before attempting to charge a payer. A checkout captures the payment intent, such as the amount, currency, merchant, ...

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 plat...

SumUp Members API

Endpoints to manage account members. Members are users that have membership within merchant accounts.

SumUp Memberships API

Endpoints to manage user's memberships. Memberships are used to connect the user to merchant accounts and to grant them access to the merchant's resources via roles.

SumUp Merchants API

Merchant account represents a single business entity at SumUp.

SumUp Payouts API

The Payouts model will allow you to track funds you’ve received from SumUp. You can receive a detailed payouts list with information like dates, fees, references and statuses, u...

SumUp Readers API

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

SumUp Receipts API

The Receipts model obtains receipt-like details for specific transactions.

SumUp Roles API

Endpoints to manage custom roles. Custom roles allow you to tailor roles from individual permissions to match your needs. Once created, you can assign your custom roles to your ...

SumUp Transactions API

Transactions represent completed or attempted payment operations processed for a merchant account. A transaction contains the core payment result, such as the amount, currency, ...

Scroll for all 10

Pricing Plans 1

Published pricing tiers and plan structures.

Sumup Plans Pricing

5 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Sumup Rate Limits

1 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Sumup Finops

FINOPS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

SumUp API Rules

5 rules · 4 warnings 1 info

SPECTRAL

JSON Schema 99

Standalone JSON Schema definitions for this provider's data models.

Address

17 properties

JSON SCHEMA

Address Legacy

6 properties

JSON SCHEMA

Attributes

0 properties

JSON SCHEMA

BadRequest

1 properties

JSON SCHEMA

BasePerson

16 properties

JSON SCHEMA

Branding

8 properties

JSON SCHEMA

BusinessProfile

7 properties

JSON SCHEMA

Card

7 properties

JSON SCHEMA

Card Response

2 properties

JSON SCHEMA

Card Type

0 properties

JSON SCHEMA

ChangeStatus

0 properties

JSON SCHEMA

Checkout

14 properties

JSON SCHEMA

Checkout Accepted

1 properties

JSON SCHEMA

Checkout Create Request

11 properties

JSON SCHEMA

Checkout Success

0 properties

JSON SCHEMA

ClassicMerchantIdentifiers

1 properties

JSON SCHEMA

Company

9 properties

JSON SCHEMA

CompanyIdentifier

2 properties

JSON SCHEMA

CompanyIdentifiers

0 properties

JSON SCHEMA

CountryCode

0 properties

JSON SCHEMA

CreateReaderCheckoutError

1 properties

JSON SCHEMA

CreateReaderCheckoutRequest

9 properties

JSON SCHEMA

CreateReaderCheckoutResponse

1 properties

JSON SCHEMA

CreateReaderTerminateError

1 properties

JSON SCHEMA

Currency

0 properties

JSON SCHEMA

Customer

2 properties

JSON SCHEMA

Details Error

4 properties

JSON SCHEMA

Device

5 properties

JSON SCHEMA

ELV Card Account

4 properties

JSON SCHEMA

Entry Mode

0 properties

JSON SCHEMA

Error

2 properties

JSON SCHEMA

Error Extended

0 properties

JSON SCHEMA

Error Forbidden

3 properties

JSON SCHEMA

Event

10 properties

JSON SCHEMA

Event ID

0 properties

JSON SCHEMA

Event Status

0 properties

JSON SCHEMA

Event Type

0 properties

JSON SCHEMA

Financial Payout

9 properties

JSON SCHEMA

Financial Payouts

0 properties

JSON SCHEMA

Horizontal Accuracy

0 properties

JSON SCHEMA

Hosted Checkout

1 properties

JSON SCHEMA

Invite

2 properties

JSON SCHEMA

Latitude

0 properties

JSON SCHEMA

LegalType

0 properties

JSON SCHEMA

Link

5 properties

JSON SCHEMA

ListPersonsResponseBody

1 properties

JSON SCHEMA

Longitude

0 properties

JSON SCHEMA

Mandate Payload

3 properties

JSON SCHEMA

Mandate Response

3 properties

JSON SCHEMA

Member

10 properties

JSON SCHEMA

Membership

12 properties

JSON SCHEMA

Resource

7 properties

JSON SCHEMA

MembershipStatus

0 properties

JSON SCHEMA

MembershipUser

9 properties

JSON SCHEMA

MembershipUserClassic

1 properties

JSON SCHEMA

Merchant

0 properties

JSON SCHEMA

Meta

0 properties

JSON SCHEMA

Metadata

0 properties

JSON SCHEMA

NotFound

1 properties

JSON SCHEMA

Ownership

1 properties

JSON SCHEMA

Payment Instrument Response

6 properties

JSON SCHEMA

Payment Type

0 properties

JSON SCHEMA

Person

0 properties

JSON SCHEMA

Personal Details

7 properties

JSON SCHEMA

PersonalIdentifier

2 properties

JSON SCHEMA

PhoneNumber

0 properties

JSON SCHEMA

Problem

5 properties

JSON SCHEMA

Process Checkout

9 properties

JSON SCHEMA

Product

10 properties

JSON SCHEMA

Reader

8 properties

JSON SCHEMA

ReaderCheckoutStatusChange

4 properties

JSON SCHEMA

ReaderDevice

2 properties

JSON SCHEMA

ReaderID

0 properties

JSON SCHEMA

ReaderName

0 properties

JSON SCHEMA

ReaderPairingCode

0 properties

JSON SCHEMA

ReaderStatus

0 properties

JSON SCHEMA

Receipt

4 properties

JSON SCHEMA

Receipt Card

2 properties

JSON SCHEMA

Receipt Event

7 properties

JSON SCHEMA

Receipt Merchant Data

2 properties

JSON SCHEMA

Receipt Reader

2 properties

JSON SCHEMA

Receipt Transaction

20 properties

JSON SCHEMA

ResourceType

0 properties

JSON SCHEMA

Role

8 properties

JSON SCHEMA

StatusResponse

1 properties

JSON SCHEMA

Timestamps

2 properties

JSON SCHEMA

Transaction Base

8 properties

JSON SCHEMA

Transaction Checkout Info

5 properties

JSON SCHEMA

Transaction Event

8 properties

JSON SCHEMA

Transaction Full

0 properties

JSON SCHEMA

Transaction History

0 properties

JSON SCHEMA

Transaction ID

0 properties

JSON SCHEMA

Transaction Mixin History

4 properties

JSON SCHEMA

Transactions History Link

2 properties

JSON SCHEMA

Transaction Status

0 properties

JSON SCHEMA

Unauthorized

1 properties

JSON SCHEMA

Version

0 properties

JSON SCHEMA

Scroll for all 99

Examples 13

Example request and response payloads for these APIs.

Createcheckout Request

7 fields

EXAMPLE

Createcheckout Response 201

14 fields

EXAMPLE

Createreader Response 201

6 fields

EXAMPLE

Getcheckout Response 200

10 fields

EXAMPLE

Getreceipt Response 200

3 fields

EXAMPLE

Processcheckout Request

4 fields

EXAMPLE

Refundtransaction Request

1 fields

EXAMPLE

Scroll for all 13

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Sumup Authentication

http/oauth2 · 2 schemes

SECURITY

Sumup Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Sumup Vulnerability Disclosure

Hackerone · security.txt · contact published

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Sumup Scopes

10 scopes · authorizationCode/clientCredentials

10 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Sumup Agentic Access

39 operations · 19 acting · 1 human-in-the-loop

39 operations · 19 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Build 2

SDKs, sample code, and the tooling you integrate with

Access & Security 4

Authentication, authorization, and security posture

Operate 3

Status, limits, changes, and where to get help

Commercial 3

Pricing, plans, and the legal terms of use

Company 3

The organization behind the API

Other 1

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: sumup
name: SumUp
description: European mobile payment and POS platform with REST APIs for creating checkout links, managing card readers, processing
  payments, tracking transactions, and accessing payout data. SumUp serves over 4 million merchants in 37 markets with built-in
  fraud protection, sandbox environments for testing, and SDKs for multiple programming languages.
accessModel:
  pricing: paid
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Paid · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/sumup.png
url: https://raw.githubusercontent.com/api-evangelist/sumup/refs/heads/main/apis.yml
created: '2026-06-13'
modified: '2026-06-13'
specificationVersion: '0.19'
tags:
- Payments
- POS
- Point of Sale
- Card Readers
- Checkout
- Fintech
- Mobile Payments
- Online Payments
apis:
- aid: sumup:sumup-checkouts-api
  name: SumUp Checkouts API
  description: 'Checkouts represent online payment sessions that you create before attempting to charge a payer. A checkout
    captures the payment intent, such as the amount, currency, merchant, and optional customer or redirect settings, and then
    moves through its lifecycle as you process it.


    Use this tag to:

    - create a checkout before collecting or confirming payment details

    - process the checkout with a card, saved card, wallet, or supported alternative payment method

    - retrieve or list checkouts to inspect their current state and associated payment attempts

    - deactivate a checkout that should no longer be used


    Typical workflow:

    - create a checkout with the order amount, currency, and merchant information

    - process the checkout through SumUp client tools such as the [Payment Widget and Swift Checkout SDK](https://developer.sumup.com/online-payments/checkouts)

    - retrieve the checkout or use the Transactions endpoints to inspect the resulting payment record


    Checkouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting
    payment outcome.'
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Checkouts
  properties:
  - type: OpenAPI
    url: openapi/sumup-checkouts-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-customers-api
  name: SumUp Customers API
  description: '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.'
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/sumup-customers-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-members-api
  name: SumUp Members API
  description: Endpoints to manage account members. Members are users that have membership within merchant accounts.
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Members
  properties:
  - type: OpenAPI
    url: openapi/sumup-members-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-memberships-api
  name: SumUp Memberships API
  description: Endpoints to manage user's memberships. Memberships are used to connect the user to merchant accounts and to
    grant them access to the merchant's resources via roles.
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Memberships
  properties:
  - type: OpenAPI
    url: openapi/sumup-memberships-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-merchants-api
  name: SumUp Merchants API
  description: Merchant account represents a single business entity at SumUp.
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Merchants
  properties:
  - type: OpenAPI
    url: openapi/sumup-merchants-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-payouts-api
  name: SumUp Payouts API
  description: 'The Payouts model will allow you to track funds you’ve received from SumUp.


    You can receive a detailed payouts list with information like dates, fees, references and statuses, using the `List payouts`
    endpoint.'
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Payouts
  properties:
  - type: OpenAPI
    url: openapi/sumup-payouts-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-readers-api
  name: SumUp Readers API
  description: A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Readers
  properties:
  - type: OpenAPI
    url: openapi/sumup-readers-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-receipts-api
  name: SumUp Receipts API
  description: The Receipts model obtains receipt-like details for specific transactions.
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Receipts
  properties:
  - type: OpenAPI
    url: openapi/sumup-receipts-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-roles-api
  name: SumUp Roles API
  description: Endpoints to manage custom roles. Custom roles allow you to tailor roles from individual permissions to match
    your needs. Once created, you can assign your custom roles to your merchant account members using the memberships.
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Roles
  properties:
  - type: OpenAPI
    url: openapi/sumup-roles-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
- aid: sumup:sumup-transactions-api
  name: SumUp Transactions API
  description: 'Transactions represent completed or attempted payment operations processed for a merchant account. A transaction
    contains the core payment result, such as the amount, currency, payment method, creation time, and current high-level
    status.


    In addition to the main payment outcome, a transaction can contain related events that describe what happened after the
    original payment attempt. These events provide visibility into the financial lifecycle of the transaction, for example:

    - `PAYOUT`: the payment being prepared for payout or included in a payout to the merchant

    - `REFUND`: money returned to the payer

    - `CHARGE_BACK`: money reversed after the original payment

    - `PAYOUT_DEDUCTION`: an amount deducted from a payout to cover a refund or chargeback


    From an integrator''s perspective, transactions are the authoritative record of payment outcomes. Use this tag to:

    - list transactions for reporting, reconciliation, and customer support workflows

    - retrieve a single transaction when you need the latest payment details

    - inspect `simple_status` for the current merchant-facing outcome of the payment

    - inspect `events` or `transaction_events` when you need refund, payout, or chargeback history


    Typical workflow:

    - create and process payments through the Checkouts endpoints

    - use the Transactions endpoints to read the resulting payment records

    - use the returned statuses and events to update your own order, accounting, or support systems'
  humanURL: https://developer.sumup.com/api
  baseURL: https://api.sumup.com
  tags:
  - Transactions
  properties:
  - type: OpenAPI
    url: openapi/sumup-transactions-api-openapi.yml
  - type: Documentation
    url: https://developer.sumup.com/api
  - type: PostmanCollection
    url: https://www.postman.com/sumupengineering/sumup-developers/collection/iqa7nry/sumup-rest-api
common:
- type: AgenticAccess
  url: agentic-access/sumup-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/sumup-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/sumup-domain-security.yml
- type: Authentication
  url: authentication/sumup-authentication.yml
- type: OAuthScopes
  url: scopes/sumup-scopes.yml
- type: Website
  url: https://sumup.com
- type: Documentation
  url: https://developer.sumup.com
- type: GitHubOrg
  url: https://github.com/sumup
- type: LinkedIn
  url: https://www.linkedin.com/company/sumup
- type: Blog
  url: https://medium.com/sumup-engineering
- type: Pricing
  url: https://sumup.com/pricing/
- type: StatusPage
  url: https://status.sumup.com/
- type: X
  url: https://x.com/SumUp
- type: Plans
  url: plans/sumup-plans-pricing.yml
- type: RateLimits
  url: rate-limits/sumup-rate-limits.yml
- type: FinOps
  url: finops/sumup-finops.yml
- type: ChangeLog
  url: https://developer.sumup.com/changelog
- type: GitHubRepository
  url: https://github.com/sumup/sumup-openapi
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com