var c=Object.defineProperty,m=Object.defineProperties;var u=Object.getOwnPropertyDescriptors;var i=Object.getOwnPropertySymbols;var r=Object.prototype.hasOwnProperty,p=Object.prototype.propertyIsEnumerable;var s=(t,o,a)=>o in t?c(t,o,{enumerable:!0,configurable:!0,writable:!0,value:a}):t[o]=a,e=(t,o)=>{for(var a in o||(o={}))r.call(o,a)&&s(t,a,o[a]);if(i)for(var a of i(o))p.call(o,a)&&s(t,a,o[a]);return t},l=(t,o)=>m(t,u(o));var d=(t,o)=>{var a={};for(var n in t)r.call(t,n)&&o.indexOf(n)<0&&(a[n]=t[n]);if(t!=null&&i)for(var n of i(t))o.indexOf(n)<0&&p.call(t,n)&&(a[n]=t[n]);return a};const layoutProps={},MDXLayout="wrapper";function MDXContent(a){var n=a,{components:t}=n,o=d(n,["components"]);return mdx(MDXLayout,l(e(e({},layoutProps),o),{components:t,mdxType:"MDXLayout"}),mdx("p",null,"The Zettle Payments SDK for iOS lets you take card payments from any iOS app, using a PayPal Reader/Zettle Reader. The following describes how to install, configure and initialize the SDK."),mdx("h2",e({},{id:"prerequisites"}),"Prerequisites"),mdx("ul",null,mdx("li",{parentName:"ul"},"Xcode 14.1+"),mdx("li",{parentName:"ul"},mdx("inlineCode",{parentName:"li"},"ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES")," flag is required if your project doesn't include Swift"),mdx("li",{parentName:"ul"},"iOS 12 and higher"),mdx("li",{parentName:"ul"},"Client ID from the Zettle Developer Portal, see ",mdx("a",e({parentName:"li"},{href:"/docs/ios-sdk/get-started"}),"Get started"),".")),mdx("blockquote",null,mdx("p",{parentName:"blockquote"},mdx("strong",{parentName:"p"},"Note:")," Support for iOS 10 and 11 was dropped with version 3.4.0 of the iOS SDK.")),mdx("h2",e({},{id:"install-the-sdk"}),"Install the SDK"),mdx("p",null,"You can install Zettle SDK using Swift Package Manager (SwiftPM), CocoaPods, or manually as described in the following."),mdx("h3",e({},{id:"install-using-swift-package-manager"}),"Install using Swift Package Manager"),mdx("p",null,mdx("a",e({parentName:"p"},{href:"https://www.swift.org/documentation/package-manager/"}),"SwiftPM")," is the recommended way to install Zettle SDK."),mdx("p",null,"To add the Zettle SDK package to your Xcode project, select File > Swift Packages > Add Package Dependency and enter ",mdx("a",e({parentName:"p"},{href:"https://github.com/iZettle/sdk-ios"}),"https://github.com/iZettle/sdk-ios")," as the repository URL. For more options and information, see",mdx("a",e({parentName:"p"},{href:"https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app"}),"Apple developer article"),"."),mdx("blockquote",null,mdx("p",{parentName:"blockquote"},mdx("strong",{parentName:"p"},"Note:")," This feature is only available in version 3.6 or newer.")),mdx("h3",e({},{id:"install-using-cocoapods"}),"Install using CocoaPods"),mdx("p",null,mdx("a",e({parentName:"p"},{href:"http://www.cocoapods.org/"}),"CocoaPods")," is an easy way to install Zettle SDK."),mdx("p",null,"Add following pod to your ",mdx("inlineCode",{parentName:"p"},"Podfile"),":"),mdx("pre",null,mdx("code",e({parentName:"pre"},{className:"language-ruby"}),`platform :ios, '' target 'Your App' do pod 'iZettleSDK' end `)),mdx("h3",e({},{id:"install-manually"}),"Install manually"),mdx("p",null,"Drag the binary frameworks from the ",mdx("inlineCode",{parentName:"p"},"iZettleSDK")," folder into your Xcode project:"),mdx("pre",null,mdx("code",e({parentName:"pre"},{}),`iZettleSDK.xcframework iZettlePayments.xcframework PPRiskMagnes.xcframework `)),mdx("p",null,`You can drag these into a folder named "Frameworks" for example in your Xcode project. See the `,mdx("inlineCode",{parentName:"p"},"iZettleSDK")," folder in ",mdx("a",e({parentName:"p"},{href:"https://github.com/iZettle/sdk-ios"}),"iOS SDK GitHub repository"),"."),mdx("p",null,"Ensure that you check the ",mdx("inlineCode",{parentName:"p"},"Copy items if needed")," option as shown below."),mdx("p",null,mdx("img",e({parentName:"p"},{src:"/images/copy-items.png",alt:"This image shows the Copy items if needed checkbox option",width:872,height:532}))),mdx("p",null,"You should now see these frameworks in the ",mdx("inlineCode",{parentName:"p"},"Embed Frameworks")," section of your target's ",mdx("inlineCode",{parentName:"p"},"Build Phases"),"."),mdx("h2",e({},{id:"configure-the-sdk"}),"Configure the SDK"),mdx("p",null,"To be able to use the SDK you must first add configurations as described in the following."),mdx("p",null,mdx("strong",{parentName:"p"},"Note:")," An exception will be thrown if these configurations are not done."),mdx("h3",e({},{id:"1-set-up-external-accessory-communication-background-mode"}),"1. Set up external accessory communication background mode"),mdx("h4",e({},{id:"11-xcode-modifications"}),"1.1 Xcode modifications"),mdx("p",null,mdx("strong",{parentName:"p"},"Xcode 14.1")),mdx("p",null,"Select the following background modes to enable support for external accessory communication. You can find them under ",mdx("inlineCode",{parentName:"p"},"Signing & Capabilities")," in your target."),mdx("ul",null,mdx("li",{parentName:"ul"},mdx("inlineCode",{parentName:"li"},"External accessory communication")),mdx("li",{parentName:"ul"},mdx("inlineCode",{parentName:"li"},"Uses Bluetooth LE accessory"))),mdx("p",null,mdx("strong",{parentName:"p"},"Earlier Xcode versions")),mdx("p",null,"In your Xcode project, select the ",mdx("strong",{parentName:"p"},"Capabilities")," tab. Go to the ",mdx("strong",{parentName:"p"},"Background modes")," section to enable external accessory communication support."),mdx("h4",e({},{id:"12-infoplist-modifications"}),"1.2 Info.plist modifications"),mdx("p",null,"Edit your ",mdx("strong",{parentName:"p"},"Info.plist")," file to have the following information set:"),mdx("pre",null,mdx("code",e({parentName:"pre"},{className:"language-xml"}),`NSBluetoothAlwaysUsageDescription Our app uses bluetooth to find, connect and transfer data with Zettle card reader devices. NSBluetoothPeripheralUsageDescription Our app uses bluetooth to find, connect and transfer data with Zettle card reader devices. CFBundleURLTypes CFBundleTypeRole Editor CFBundleURLSchemes "The scheme of your OAuth Redirect URI *" // Example: if your oAuth Redirect URI is "awesomeapp://zettlelogin", then the scheme of your OAuth Redirect URI is "awesomeapp" `)),mdx("blockquote",null,mdx("p",{parentName:"blockquote"},mdx("strong",{parentName:"p"},"Note:")," Zettle will ask the user for permission to allow your app access to Bluetooth capabilities. Doing so, the texts for ",mdx("inlineCode",{parentName:"p"},"NSLocationWhenInUseUsageDescription")," and ",mdx("inlineCode",{parentName:"p"},"NSBluetoothPeripheralUsageDescription")," keys are displayed. You may want to update these texts to your requirements.")),mdx("p",null,"If you don't remember the scheme of your OAuth Redirect URI, you can verify it on the ",mdx("a",e({parentName:"p"},{href:"https://developer.zettle.com/"}),"Developer Portal"),"."),mdx("h4",e({},{id:"13-set-up-external-accessory-protocols"}),"1.3 Set up external accessory protocols"),mdx("p",null,"In your ",mdx("inlineCode",{parentName:"p"},"Info.plist"),", add/modify the property ",mdx("inlineCode",{parentName:"p"},"Supported external accessory protocols")," and add ",mdx("inlineCode",{parentName:"p"},"com.izettle.cardreader-one")," as shown below:"),mdx("pre",null,mdx("code",e({parentName:"pre"},{className:"language-xml"}),`UISupportedExternalAccessoryProtocols com.izettle.cardreader-one `)),mdx("p",null,mdx("strong",{parentName:"p"},"Important:")," The Zettle Bluetooth card readers are a part of the Apple MFi program. In order to release apps supporting accessories that are part of the MFi Program, you have to apply at Apple. Please contact our ",mdx("a",e({parentName:"p"},{href:"https://ext-izettle.atlassian.net/servicedesk/customer/portal/3/group/4/create/24"}),"developer support")," and we will help you with this process."),mdx("h3",e({},{id:"2-set-up-cllocationmanager"}),"2. Set up CLLocationManager"),mdx("p",null,"The merchant must grant your app this permission. If not done, Zettle will prompt the user for permission during the first payment and execute the ",mdx("inlineCode",{parentName:"p"},"CLLocationManagers")," method ",mdx("inlineCode",{parentName:"p"},"requestWhenInUseAuthorization"),"."),mdx("p",null,"Add the key in your ",mdx("inlineCode",{parentName:"p"},"Info.plist"),":"),mdx("pre",null,mdx("code",e({parentName:"pre"},{className:"language-xml"}),`NSLocationWhenInUseUsageDescription You need to allow this to be able to accept card payments `)),mdx("p",null,"Zettle won't accept payments without these texts implemented."),mdx("p",null,"Eventually, your ",mdx("inlineCode",{parentName:"p"},"Info.plist"),` file should look like this in your Xcode editor UI: `,mdx("img",e({parentName:"p"},{src:"/images/InfopList.png",alt:"Info.plist view which consists of key-value pairs for iOS properties ",width:1321,height:900}))),mdx("hr",null),mdx("p",null,mdx("strong",{parentName:"p"},"Important:")," Whenever you work with SDK code, ensure that you always import the SDK framework in your code files. If you do not import the framework, it will not be accessible in your code."),mdx("p",null,mdx("strong",{parentName:"p"},"Objective-C:")),mdx("pre",null,mdx("code",e({parentName:"pre"},{className:"language-objective-c"}),`@import iZettleSDK; `)),mdx("p",null,mdx("strong",{parentName:"p"},"Swift:")),mdx("pre",null,mdx("code",e({parentName:"pre"},{className:"language-swift"}),`import iZettleSDK `)),mdx("h2",e({},{id:"next-step"}),"Next step"),mdx("ul",null,mdx("li",{parentName:"ul"},mdx("a",e({parentName:"li"},{href:"/docs/ios-sdk/initialization"}),"Initialisation"))))}MDXContent.isMDXComponent=!0;