Skip to main content
Version: 1.0.0

SumUp REST API

SumUp’s REST API operates with application/json HTTP requests and response. The request bodies are sent through resource-oriented URLs and use the standard HTTP response codes.

For testing our APIs, please contact us for a test account.

When you receive your test account you can create your client credentials and process different requests with real payment instruments, without charging them.

Authentication​

At SumUp authentication uses your API credentials and Basic HTTP auth. The API credentials consist of a client_id and client_secret key-value pair.

It is possible to create multiple API credentials for each of the applications you connect with your SumUp account.

Use the API credentials as an authorization header for requests that require such.

Authorization​

SumUp uses the OAuth 2.0 authorization framework and supports two authorization flows for obtaining an access token.

The flow you choose will grant your access token specific permissions. All API calls should include the obtained access token in the Authorization: Bearer <<valid_access_token>> format.

To complete successful requests, ensure you have requested the necessary scopes for your authorization flow of choice.

Security Scheme Type:oauth2
authorizationCode OAuth Flow:

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

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

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

Scopes:
  • payments: Make payments by creating and processing checkouts.
  • transactions.history: View transactions and transaction history.
  • user.profile_readonly: View user profile details.
  • user.profile: View and manage your user profile.
  • user.app-settings: View and manage the SumUp mobile application settings.
  • payment_instruments: Manage customers and their payment instruments.
  • user.payout-settings: View and manage your payout settings.
  • user.subaccounts: View and manage the user profile details of your employees.
clientCredentials OAuth Flow:

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

Scopes:
  • payments: Make payments by creating and processing checkouts.
  • transactions.history: View transactions and transaction history.
  • user.profile_readonly: View user profile details.
  • user.profile: View and manage your user profile.
  • user.app-settings: View and manage the SumUp mobile application settings.
  • payment_instruments: Manage customers and their payment instruments.
  • user.payout-settings: View and manage your payout settings.
  • user.subaccounts: View and manage the user profile details of your employee.