Account

Understand how merchant and user accounts are related and how permissions govern access.

SumUp separates business data in merchant accounts from the user accounts people use to sign in. When a user can access multiple merchant accounts, use the Account APIs to select the right merchant code and manage team permissions.

Understand and choose an account

Manage member access

  • Roles and permissions: understand system roles, permissions, and how they relate to OAuth scopes.
  • Manage members: invite people, assign roles, manage user logins, and remove access.

Authorize your integration

Use an API key or OAuth access token to call the account APIs. For OAuth requests, the user needs the required permissions and the token needs the endpoint’s required scopes. See permissions and OAuth scopes for how they work together.

Run the examples

Follow the authorization guide to get credentials, and install your language’s server SDK if you use the SDK examples.

The examples in this section read these environment variables:

  • SUMUP_ACCESS_TOKEN: your API key or OAuth access token.
  • SUMUP_MERCHANT_CODE: the merchant code for requests that act on a specific account.

Type to search…