Overview of iOS SDK

The Zettle Payments SDK for iOS lets you take payments from any iOS app, using a Zettle card reader or QRC.
The SDK is designed for easy implementation and usage. The SDK places a screen over the host application when triggered. This screen is used for all interactions.
Explore the following sections to get an understanding of the Zettle Payments SDK for iOS.

Market availability

Currently, the iOS SDK offers 3 payment methods: Card payments, Manual Card Entry Payments (MCE) and QRC payments using PayPal or Venmo. The following table describes their availability in different markets.
MarketCard PaymentsPayPal QRCVenmo QRCManual Card Entry
United StatesXXXX
United KingdomXX--
SwedenX---
BrazilX---
NorwayX---
DenmarkX---
FinlandX---
GermanyXX--
MexicoX---
NetherlandsX---
FranceX---
SpainX---
ItalyX---
You can integrate your point of sales (POS) with the Zettle SDK in supported markets only. This applies regardless of where you are located.

Main features

  • Take card payments with a Zettle card reader.
  • Take card payments using Manual Card Entry.
  • 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.

Limitations

  • The SDK requires the use of Xcode 14.1.
  • PayPal QRC and Venmo QRC payments are only supported on iOS 13 and higher.

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 iOS SDK

Manage card payments

  • Charging
  • Refunding
  • Retrieving payment information
  • Completing payments

Manage Manual Card Entry payments

  • Charging
  • Refunding
  • Retrieving payment information
  • Completing payments

Manage PayPal QRC payments

  • Charging
  • Refunding
  • Retrieving payment information
  • Completing payments

Manage tipping

The tipping flows explained.

Other operations

Card reader pairing

How to pair the card reader.

Upgrading

Upgrading instructions for major versions.