Overview of Android SDK

The Zettle payment SDK for Android lets you accept payments from an Android app, using a Zettle card reader or QRC. The SDK is compatible with apps supporting Android API level 21 and above. The SDK itself is written in Kotlin which is the preferred language, however examples are available both in Kotlin and in Java.

Market availability

Currently there are these ways to handle payments with the SDK: Card payments, and QRC using PayPal or Venmo. The following table describes the availability in different markets.

MarketCard PaymentsPayPal QRCVenmo QRC
United StatesXXX
United KingdomXX-
SwedenX--
BrazilX--
NorwayX--
DenmarkX--
FinlandX--
GermanyXX-
MexicoX--
NetherlandsX--
FranceX--
SpainX--
ItalyX--

You can only integrate your point of sales (POS) with the Zettle SDK in supported markets. This applies regardless of where you are located.

Note: To test your integration with the Zettle SDK, you need to order a card reader. This can only be done if you are located in a supported market.

Main features

  • Take card payments with a Zettle card reader.
  • Take PayPal QRC payments.
  • Take Venmo QRC payments.
  • Refund card payments.
  • Receive information about a payment.
  • Login/logout of Zettle accounts and simple switching between multiple accounts.
  • Settings screen. From this a user can handle card readers and access help and support.

Getting started

How to get the accounts and app credentials needed to work with your SDK integration.

Installation and configuration

How to add the SDK to your project, and configure different components.

Initialisation

How to initialise and start the SDK.

Concepts

Explanation of common concepts.

Working with the Android SDK

Manage card payments

  • Starting payments
  • Processing payment results incl. SDK_CardPaymentResult
  • Retrieving payments
  • Refunding payments
  • Processing refund results incl. SDK_CardPaymentRefundResult
  • Settings - card reader settings

See Manage card payments.

Manage PayPal QRC payments

  • Starting payments
  • Processing payment results incl. SDK_PayPalQrcPaymentResult
  • Retrieving payments
  • Refunding payments
  • Processing refund results incl. SDK_PayPalQrcRefundResult
  • Settings – PayPal QRC activation

See Manage PayPal QRC payments.

Manage tipping

The tipping flows explained.

Card reader pairing

How to pair the card reader.