Zettle 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 SDK | Use | OAuth scope | Commonly used with |
|---|---|---|---|
| Finance | Provides information about transactions that are processed through Zettle. The information includes account balance, all the transactions processed through Zettle, and payout. | READ:FINANCE |
|
| Gift Card | Provides information about purchases made through Zettle with a gift card | READ:PURCHASE |
|
| Image | Allows uploading of product images to be stored and used within the Zettle applications. | READ:PRODUCT |
|
| Inventory | Keeps track of the stock level for variants within products | READ:PRODUCTWRITE:PRODUCT | OAuth |
| OAuth | Handles authentication and authorisation for an integration with Zettle. It implements the OAuth 2.0 protocol. | Not applicable | All APIs |
| Product Library | Manages information about products in a merchant´s store. | READ:PRODUCT WRITE:PRODUCT |
|
| Purchase | Provides read-only information about purchases made through Zettle. | READ:PURCHASE |
|
| Pusher | Publishes information to the integrator's service. This information is data related to products, purchases, inventory, and so on. | Corresponding to events | All APIs |
| Android SDK | Allows 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:PAYMENTREAD:USERINFOWRITE:PAYMENTWRITE:REFUND2 |
|
| iOS SDK | Allows 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:PAYMENTREAD:USERINFOWRITE:PAYMENTWRITE:REFUND2 |
|
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.
| Market | APIs | Android SDK | iOS SDK |
|---|---|---|---|
| United States | Not supported | Supported | Supported |
| United Kingdom | Supported | Supported | Supported |
| Sweden | Supported | Supported | Supported |
| Brazil | Supported | Supported | Supported |
| Norway | Supported | Supported | Supported |
| Denmark | Supported | Supported | Supported |
| Finland | Supported | Supported | Supported |
| Germany | Supported | Supported | Supported |
| Mexico | Supported | Supported | Supported |
| Netherlands | Supported | Supported | Supported |
| France | Supported | Supported | Supported |
| Spain | Supported | Supported | Supported |
| Italy | Supported | Supported | Supported |