Zettle APIs and SDKs

Available APIs and SDKs

The following describes the APIs and SDKs available for integration with Zettle.

Authentication and authorisation is implemented with the OAuth 2.0 standard. The OAuth scope shows what access that your app users will authorise the app to their Zettle account data. For example, READ:PURCHASE means read-only access to purchase data.

API and SDKUseOAuth scopeCommonly used with
FinanceProvides information about transactions that are processed through Zettle. The information includes account balance, all the transactions processed through Zettle, and payout.READ:FINANCE
  • Purchase
  • OAuth
Gift CardProvides information about purchases made through Zettle with a gift cardREAD:PURCHASE
  • Purchase
  • OAuth
ImageAllows uploading of product images to be stored and used within the Zettle applications.READ:PRODUCT
  • Product Library
  • OAuth
InventoryKeeps track of the stock level for variants within productsREAD:PRODUCT
WRITE:PRODUCT
OAuth
OAuthHandles authentication and authorisation for an integration with Zettle. It implements the OAuth 2.0 protocol.Not applicableAll APIs
Product LibraryManages information about products in a merchant´s store.READ:PRODUCT WRITE:PRODUCT
  • Image
  • OAuth
PurchaseProvides read-only information about purchases made through Zettle.READ:PURCHASE
  • Finance
  • Gift Card
  • OAuth
PusherPublishes information to the integrator's service. This information is data related to products, purchases, inventory, and so on.Corresponding to eventsAll APIs
Android SDKAllows you to take card and contactless payments with Zettle. The supported payment methods are card and contactless such as PayPal QRC. The SDK is available in Kotlin. The example is in Kotlin and Java.READ:PAYMENT
READ:USERINFO
WRITE:PAYMENT
WRITE:REFUND2
  • Finance
  • Purchase
iOS SDKAllows you to take card and contactless payments with Zettle. The supported payment methods are card and contactless such as PayPal QRC. The SDK is available in Objective-C and Swift. The example is also in Objective-C.READ:PAYMENT
READ:USERINFO
WRITE:PAYMENT
WRITE:REFUND2
  • Finance
  • Purchase

Supported markets

Regardless of where you are located when building the app, you can only integrate with Zettle in supported markets.

Note: The Zettle APIs are currently not supported in the US.

MarketAPIsAndroid SDKiOS SDK
United StatesNot supportedSupportedSupported
United KingdomSupportedSupportedSupported
SwedenSupportedSupportedSupported
BrazilSupportedSupportedSupported
NorwaySupportedSupportedSupported
DenmarkSupportedSupportedSupported
FinlandSupportedSupportedSupported
GermanySupportedSupportedSupported
MexicoSupportedSupportedSupported
NetherlandsSupportedSupportedSupported
FranceSupportedSupportedSupported
SpainSupportedSupportedSupported
ItalySupportedSupportedSupported