FastCheckout iOS SDK

Manual

Introduction

As an integrator, you only need to provide a valid MSP transaction identifier or create a transaction. The FastCheckout SDK leverages the checkout process for you, providing notifications for all possible outcomes (success, pending, cancelled, etc.) once it completes a transaction. The checkout process flow includes:

• Shipping details:
  • Preferred shipping details
  • Add shipping details
• Payment methods:
  • Preferred payment methods
  • Add payment methods
  • Gift cards
• Confirmation details

Additional details

The FastCheckout SDK provides the additional following features:

• Authentication into FastCheckout:
  • It provides secure sign-up/login functionality
• Check orders:
  • Open seamless support tickets to related orders
• Support orders:
  • Easily open a support ticket related to an order
• Edit payment information:
  • List and edit user’s stored payment details
• Manage shipping addresses:
  • List, add and edit shipping information

For more information, see the documentation inside the SDK, which contains all classes, methods, common troubleshooting and more details.

To learn more about creating, updating and retrieving orders, see API reference - Orders.

Requirements

• Xcode 11.0 and iOS 13 SDK
• iOS 9+ target
• Swift 5.1 or Objective-C

Installation

First you have to access into your Back Office and get a valid API key (Settings > Website Settings).

Once you have your valid API key, you can get the SDK on our GitHub repository

Add the FastCheckoutKit.xcframework as an embedded framework into your project. The next steps will guide you through the process:

1. Open the folder in Finder where you have downloaded FastCheckoutKit.framework and drag it into the Project Navigator of your application’s Xcode project.
2. Make sure you select Copy items if needed unless you have already copied the framework into your project folder.
3. Select your application project in the Project Navigator (blue project icon) to navigate to target configuration window and select the application target under the Targets heading in the sidebar.
4. In the tab bar at the top of that window, open the General panel.
5. Click on the + button under the Embedded Binaries section.
6. Select FastCheckoutKit.xcframework

You can now start using the FastCheckoutKit SDK in your App.

Demo

You can easily integrate FastCheckout iOS SDK into your app, you just need to follow the next steps:

1. Setup iOS SDK

import FastcheckoutKit

let manager = FastcheckoutManager(client: FastcheckoutClient(apiKey: "API_KEY"))

2. Start checkout with completion callback

manager.startCheckout(transactionId: "ID", host: self, onCompletion: { status, error in
    if let status = status {
        print(status)
    } else {
        print(error?.localizedDescription)
    }
})

And that’s it, that’s all you need to do to integrate the iOS SDK to start a checkout and retrieve the transaction status once it completes.

Complete example

import UIKit
import FastcheckoutKit

class ViewController: UIViewController {

   private let manager = FastcheckoutManager(client: FastcheckoutClient(apiKey: "API_KEY"))

   override func viewDidLoad() {
       super.viewDidLoad()

       // Add a button to the navigationBar
       let startButton = UIBarButtonItem(title: "Start",
                                         style: .done,
                                         target: self,
                                         action: #selector(self.startCheckout))
       navigationItem.rightBarButtonItem = startButton
   }

   // MARK: Actions

   @objc func startCheckout() {
       manager.startCheckout(transactionId: "id", host: self, onCompletion: { status, error in
           if let status = status {
               print(status)
               switch status.state {
                case .cancelled:
                    break
                case .completed:
                    break
                case .declined:
                    break
                case .pending:
                    break
                case .uncleared:
                    break
                @unknown default:
                    break
                }
           } else {
               print(error?.localizedDescription)
           }
       })
   }

}

Advanced setup

The SDK has two environments on which to operate, LIVE and TEST. You might want to test your integration in the TEST environment before release because no real transaction is performed in TEST environment. To do this you will have to customize the SDK behaviour, because by default it uses LIVE environment among other things.

To be able to customize some aspects of the SDK, the integrator will be able to inject some properties into it. Check out the example below to see how you can select which environment to use among other things. Keep in mind that you may not need to do this at all.

// Build `Settings` object to customize FCO SDK
let settings = Settings.build()
settings.environmentKey = FastcheckoutTestEnvironment
settings.debug = true
settings.biometricAuthenticationEnabled = true
settings.skipShowCartAtBeginning = true
        
let client = FastcheckoutClient(apiKey: apiKey, settings: settings)
self.manager = FastcheckoutManager(client: client)

SDK Snapshots

1. The following snapshots will walk you through some of features offered by the FastCheckout iOS SDK.

   • Logging in with a registered email:

     

   • Logging in with a non-registered email will automatically take the user to the register SDK screen:

     

   • If the user is registered and resets its email account, the SDK will automatically send a new security code to new entered email:

     

   • Once the user enters the security code received by email (if the security code is received via SMS it will automatically get added to appropriate field, and the SDK will move into the following state) the SDK will ask for a new security PIN, once entered, the SDK will provide Biometric options (in iOS face recognition is also available):

     

   • The checkout process follows. From a merchant’s webshop checkout option, the SDK enters into the checkout process. The first view will be the delivery view with shipping options if available. Once the continue button is selected, the SDK moves into the Payment screen and the payment logic follows.

     

   • Once the payment process is completed the SDK will proceed to the “transaction is complete” screen. The SDK callback will notify the client app about this or any other results (uncleared, cancel, etc.). Pressing the button “Back to Shop” will redirect the user to the Merchant’s webshop.