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 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, 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 usedTypical 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 recordCheckouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting payment outcome.

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

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

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

7 operations 4 paths 23 schemas 1 DELETE3 GET1 POST2 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 Checkouts 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 7

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

Checkouts 7

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, an…

GET
/v0.1/merchants/{merchant_code}/payment-methods
Get available payment methods
GetPaymentMethods 3 params → 200400
POST
/v0.1/checkouts
Create a checkout
CreateCheckout body → 201400401403409
GET
/v0.1/checkouts
List checkouts
ListCheckouts 1 param → 200401
GET
/v0.1/checkouts/{checkout_id}
Retrieve a checkout
GetCheckout 1 param → 200401404
PUT
/v0.1/checkouts/{checkout_id}
Process a checkout
ProcessCheckout 1 param body → 200202400401404409
DELETE
/v0.1/checkouts/{checkout_id}
Deactivate a checkout
DeactivateCheckout 1 param → 200401404409
PUT
/v0.2/checkouts/{checkout_id}/apple-pay-session
Create an Apple Pay session
CreateApplePaySession 1 param body → 200400404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Checkout (14 properties), CheckoutCreateRequest (11 properties), ProcessCheckout (9 properties), TransactionBase (8 properties). Each schema is shown below with its type and property counts.

Currency
string
Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO4217) code of the currency for the amount. Currently supported currency values are enumerated above.
EntryMode
string
Entry mode of the payment details.
DetailsError
object
Error message structure.
4 properties
ProcessCheckout
object
Request body for attempting payment on an existing checkout. The required companion fields depend on the selected paymenttype, for example card details, saved-…
9 properties 1 required
Problem
object
A RFC 9457 problem details object. Additional properties specific to the problem type may be present.
5 properties 1 required
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.
Checkout
object
Core checkout resource returned by the Checkouts API. A checkout is created before payment processing and then updated as payment attempts, redirects, and resu…
14 properties
PaymentType
string
Payment type used for the transaction.
HostedCheckout
object
Hosted Checkout configuration. Enable it to receive a SumUp-hosted payment page URL in the checkout response.
1 property 1 required
ErrorForbidden
object
Error message for forbidden requests.
3 properties
TransactionCheckoutInfo
object
Checkout-specific fields associated with a transaction.
5 properties
MandatePayload
object
Mandate details used when a checkout should create a reusable card token for future recurring or merchant-initiated payments.
3 properties 2 required
CheckoutCreateRequest
object
Request body for creating a checkout before processing payment. Define the payment amount, currency, merchant, and optional customer or redirect behavior here.
11 properties 4 required
ErrorExtended
Error payload with the invalid parameter reference.
PersonalDetails
object
Personal details for the customer.
7 properties
CheckoutSuccess
Checkout resource returned after a synchronous processing attempt. In addition to the base checkout fields, it can include the resulting transaction identifier…
TransactionStatus
string
Current status of the transaction. - PENDING: The transaction has been created but its final outcome is not known yet. - SUCCESSFUL: The transaction completed…
Error
object
Error message structure.
2 properties
CheckoutAccepted
object
Response returned when checkout processing requires an additional payer action, such as a 3DS challenge or a redirect to an external payment method page.
1 property
Card
object
Required when payment type is card. Details of the payment card.
7 properties 6 required
TransactionBase
object
Details of the transaction.
8 properties
AddressLegacy
object
Profile's personal address information.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sumup-checkouts-api-openapi.yml Raw ↑

Other APIs SumUp publishes across the network.

SumUp Customers 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 Checkouts 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.