Skip to content

paytrail/paytrail-ios-sdk

Repository files navigation

Paytrail iOS SDK

Introduction

The Paytrail iOS SDK is designed to streamline the integration of Paytrail payment service Web APIs for developers working on native iOS projects. The SDK encapsulates the major features of create a normal payment, save a payment card token, and pay & add card.

For the SDK's APIs guide, please check out Paytrail iOS SDK Guide.

Requirements

Requirement Minimal version
iOS 15
Swift 5
CocoaPods 1.11.3

Installation

CocoaPods

Add the line below in your project's Podfile

pod 'paytrail-ios-sdk', '~>1.0.0-beta1'

You can also specify the branch to install from

pod 'paytrail-ios-sdk', :git => 'https://github.com/paytrail/paytrail-ios-sdk.git', :branch => 'fixes/beta1'

Swift Package Manager

To add a Swift package dependency to your project, follow the guide here.

Package Lcation:

https://github.com/paytrail/paytrail-ios-sdk.git

Version Rules:

minimumVersion = "1.0.0-beta1"

Get Started

Before getting started with the SDK's APIs, a shared PaytrailMerchant should be created in the beginning when app launches in the, for example, AppDelegate:

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        ...
        PaytrailMerchant.create(merchantId: "YOUR_MERCHANT_ID", secret: "YOUR_MERCHANT_SECRET")
        PTLogger.globalLevel = .debug // Enable SDK debug logging
        return true
    }
}

Or in the main app in a SwiftUI app before any API is called:

@main
struct PaytrailSdkExamplesApp: App {
    var body: some Scene {
        WindowGroup {
            ShoppingCartView()
                .preferredColorScheme(.light)
                .onAppear {
                    PaytrailMerchant.create(merchantId: "YOUR_MERCHANT_ID", secret: "YOUR_MERCHANT_SECRET")
                    PTLogger.globalLevel = .debug // Enable SDK debug logging
                }
        }
    }
}

Examples

Paytrail SDK Examples app provides the detailed examples for the usages of the SDK's APIs.

License

Payrail iOS SDK is released under MIT License