SumUp · OAuth Scopes

SumUp OAuth Scopes

OAuth 2.0 derived

SumUp publishes 10 OAuth 2.0 scopes via the authorizationCode and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the SumUp API on a user’s behalf.

Tokens are issued from https://api.sumup.com/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Scopes: 10 Flows: authorizationCode, clientCredentials Method: derived

OAuth endpoints

Authorization URL
https://api.sumup.com/authorize

Token URL
https://api.sumup.com/token

Flows
authorizationCodeclientCredentials

Scopes (10)

Scope	Description	Flows
payment_instruments	Manage customers and their payment instruments.	authorizationCode, clientCredentials
payments	Make payments by creating and processing checkouts.	authorizationCode, clientCredentials
readers.read
readers.write
transactions.history	View transactions and transaction history.	authorizationCode, clientCredentials
user.app-settings	View and manage the SumUp mobile application settings.	authorizationCode, clientCredentials
user.payout-settings	View and manage your payout settings.	authorizationCode, clientCredentials
user.profile	View and manage your user profile.	authorizationCode, clientCredentials
user.profile_readonly	View user profile details.	authorizationCode, clientCredentials
user.subaccounts	View and manage the user profile details of your employees.	authorizationCode, clientCredentials

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-07-11'
method: derived
source: openapi/openapi.yaml
schemes:
- name: oauth2
  source: openapi/openapi.yaml
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.sumup.com/authorize
    tokenUrl: https://api.sumup.com/token
  - flow: clientCredentials
    tokenUrl: https://api.sumup.com/token
  description: |-
    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 OAuth 2.0 you will need a client credentials that you can create in the [SumUp Dashboard](https://me.sumup.com/settings/oauth2-applications).

    To maintain security of our users, we highly recommend that you use one of the [recommended OAuth 2.0 libraries](https://oauth.net/code/) for authentication.
scopes:
- scope: payment_instruments
  description: Manage customers and their payment instruments.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: payments
  description: Make payments by creating and processing checkouts.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: readers.read
  sources:
  - openapi/openapi.yaml
- scope: readers.write
  sources:
  - openapi/openapi.yaml
- scope: transactions.history
  description: View transactions and transaction history.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: user.app-settings
  description: View and manage the SumUp mobile application settings.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: user.payout-settings
  description: View and manage your payout settings.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: user.profile
  description: View and manage your user profile.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: user.profile_readonly
  description: View user profile details.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml
- scope: user.subaccounts
  description: View and manage the user profile details of your employees.
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/openapi.yaml