Get started with Android SDK

The Zettle SDKs makes it possible to build integration solutions for accepting card payments with a Zettle card reader from any Android-based app.

You need the following to get started:

  • A unique app package name to identify your Android integration app.
  • An OAuth redirect URI to your POS app. This is the callback URL to which merchants will be redirected after successful authorisation.
  • A GitHub token to access packages from GitHub. See the following how to get this.
  • An account in the Developer Portal. See the following how to get this.
  • A Client ID for your integration app. See the following how to get this.

Generate a GitHub token

The Zettle Payment 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.

Create a Developer Portal account

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

  1. Go to the Developer Portal.

  2. Enter your email, a password and click Create an account.

    Sign up and create an account in the Developer Portal

  3. Go to your email, and follow the instructions to verify your email address.

  4. You will receive a welcome email with the Developer Platform Agreement, as confirmation.

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.

  1. Log in to the Developer Portal with you developer account.

  2. In the Dashboard, click Create a new app.

  3. Select the Payments SDK for Android option.

  4. Fill in the fields in the form displayed.

    Fill in information in the form providing app details and click Get credentials

  5. Click Get credentials when done. The system auto-generates a Client ID for your app.

  6. Keep the Client ID in a safe place for later use.

    View of the information for an app