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 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, 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 chargebackFrom 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 historyTypical 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

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

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

This API exposes 3 operations across 3 paths, and defines 27 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 27 schemas 2 GET1 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 Transactions 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 — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Transactions 3

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

POST
/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds
Refund a transaction
RefundTransaction 2 params body → 204404409
GET
/v2.1/merchants/{merchant_code}/transactions
Retrieve a transaction
GetTransactionV2.1 5 params → 200401404
GET
/v2.1/merchants/{merchant_code}/transactions/history
List transactions
ListTransactionsV2.1 14 params → 200400401

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Product (10 properties), Event (10 properties), TransactionBase (8 properties), TransactionEvent (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.
TransactionID
string
Unique ID of the transaction.
HorizontalAccuracy
number
Indication of the precision of the geographical position received from the payment terminal.
EventStatus
string
Status of the transaction event. Not every value is used for every event type. - PENDING: The event has been created but is not final yet. Used for events that…
Problem
object
A RFC 9457 problem details object. Additional properties specific to the problem type may be present.
5 properties 1 required
CardType
string
Issuing card network of the payment card used for the transaction.
TransactionFull
Full transaction resource with checkout, payout, and event details.
PaymentType
string
Payment type used for the transaction.
Product
object
Purchase product.
10 properties
TransactionCheckoutInfo
object
Checkout-specific fields associated with a transaction.
5 properties
EventID
integer
Unique ID of the transaction event.
TransactionMixinHistory
object
Additional transaction fields used by history and detailed views.
4 properties
Link
object
Details of a link to a related resource.
5 properties
Event
object
High-level transaction event details.
10 properties
Lon
number
Longitude value from the coordinates of the payment location (as received from the payment terminal reader).
ElvCardAccount
object
Details of the ELV card account associated with the transaction.
4 properties
TransactionsHistoryLink
object
Hypermedia link used for transaction history pagination.
2 properties 2 required
EventType
string
Type of the transaction event.
TransactionHistory
Transaction entry returned in history listing responses.
Lat
number
Latitude value from the coordinates of the payment location (as received from the payment terminal reader).
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
TransactionEvent
object
Detailed information about a transaction event.
8 properties
TransactionBase
object
Details of the transaction.
8 properties
Device
object
Details of the device used to create the transaction.
5 properties
CardResponse
object
Details of the payment card.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sumup-transactions-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 Readers API
SumUp Receipts API
SumUp Roles API
Where this information came from

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