Overview
Zettle provides APIs and SDKs for integrating payment methods and point of sale (POS) services. For example, you have a service that runs a POS system, and you want to integrate Zettle as payment provider. Or, you want to manage inventories in your e-commerce platform for merchants that use Zettle POS.
Zettle provides a set of APIs and SDKs for integration solutions. The following picture shows basic flows on how integrators go about building integrations.
The following table describes a few terms that are good to know before you move ahead.
| Term | Description |
|---|---|
| Merchant | A seller who sells goods to customers and wants to integrate with Zettle. For example, a merchant may own a POS solution and want to integrate with Zettle APIs/SDKs to take payments. A merchant can either choose to build their own integration solution or pick up one of the featured partner integration solutions that meets their requirements. |
| Integrator | A partner company with developers, or an independent developer, who build integrations with for example Zettle. |
| Partner | A company that owns or builds integrations and has a business agreement with Zettle. May or may not have their own developers. |
| Developer | Can be either independent or a part of the development teams who work on the integration solutions with partners or merchants. If the developer is an independent entity, they can have their app promoted in at my.zettle.com by becoming a partner at zettle.com. |
| Self-hosted app | Owned by one or more merchants choosing to build their own solution. Is alternately named as a "merchant-hosted app". This app is built by the merchant if they are developers themselves or by a development team contracted by the merchant. |
| Partner-hosted app | Owned by a partner. This app is built by the partner developers or by a development team contracted by the partner. |
| Developer account | The account that the developer creates on the developer portal in order to create an API/SDK app and start building the integration solution. |
| Merchant account | The account that the merchant signs up for on zettle.com in order to authorise the app built by the developer. |
Before you start integrating with Zettle, learn more about what you can build with Zettle APIs and SDKs.
Check available APIs and SDKs and supported markets.
Regardless of where you are located when building the app, it can only be used in markets supported by Zettle.
Learn how integrations with Zettle work.
See the steps from getting authorisation to access Zettle account data of your app users to managing the app.
You can build different types of apps supporting different user scenarios, and with different authentication requirements.
Decide which APIs and SDKs to integrate, depending on the user scenarios the app will support.
Decide which type of app to build.
Depending on how you want to host the app, you can build a partner-hosted, a self-hosted, or an SDK app.
To integrate with Zettle, you need an account to create and manage apps. Sign up for a developer account in the Zettle Developer Portal, before you start creating the app.
When you have decided which type of app to build, create app credentials in the Zettle Developer Portal. You will use the credentials for app authentication and authorisation. If you want to have an app for testing purpose, create app credentials for testing and production respectively.
Try the API calls and explore the example apps.