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