Get started with Android SDK

The Zettle Payments SDK for Android makes it possible to build integration solutions for taking payments from any Android app, using a Zettle card reader or QRC.

Step 1: Create a Developer Portal account

To be able to create apps, you need an account in the Zettle Developer Portal.

See Sign up for a developer account.

Step 2: Get a Client ID

Your application is responsible for user authorisation. In the SDK, this is performed through the implementation of OAuth 2.0. The SDK OAuth API integration enables you to hook into the authorisation and authentication API. A Client ID and a callback URL from your integrating app is required for this.

See Create credentials for an SDK app.

Step 3: Get a Zettle card reader

To manage card payments with the SDK, you need to have a Zettle card reader. If you do not have one, get a card reader.

Step 4: Generate a GitHub token

The Zettle Payments SDK for Android is available as packages from the GitHub Package Registry. To be able to access these you need a GitHub Token.

  1. Click on your profile picture in GitHub.
  2. Go to Settings.
  3. Click Developer Settings.
  4. Select Personal access tokens and Generate a new token.
  5. Select the scope read:packages.
  6. Click Generate token.
  7. Save the token for later use.