DashboardFAQSystem Status

iOS

Suggest Edits

How to integrate

Lean's iOS SDK is available through Swift Package Manager. To integrate Lean’s Link SDK in XCode go to File > Swift Packages > Add Package Dependency and use the URL below:

https://github.com/leantechnologies/link-sdk-ios-distribution

Manual installation can also be achieved by adding the .xcframework available here to your project in Xcode.

You can then import the SDK into your swift files.

import LeanSDK

The latest version is: 3.0.2

Demo app

In order to test out Lean's iOS Link SDK, please refer to this guide.

Usage with Swift UI

1. Initalizing

You will need to initalize the LeanSDK within your Swift UI application by calling Lean.manager.setup(appToken, sandbox), version this sets the application token and environment during runtime of your application.

// YourApp.Swift

import SwiftUI
import LeanSDK

@main
class LeanTestAppApp: App {

    required init() {
        Lean.manager.setup(
            appToken: String,
            sandbox: true,
            version: "latest"
        )
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

2. Create the View state

You can present a Lean.manager.view anywhere in your application, however for best performance we recommend that it be placed inside a .fullScreenCover and set ignoresSafeArea() so that the view displays in full screen.

// ContentView.swift

import SwiftUI
import LeanSDK

struct ContentView: View {
    @State private var isPresented = false
    var connectPermissions = [LeanPermission.Identity, LeanPermission.Accounts,
                       LeanPermission.Transactions, LeanPermission.Balance]

    var body: some View {
        VStack {
            Button("Connect", action: { handleConnect() })
        }
    }
    .fullScreenCover(isPresented: $isPresented, content: {
        Lean.manager.view.ignoresSafeArea()
    })

    func handleConnect() {
        Lean.manager
                .connect(customerId: String, permissions: connectPermissions, customization: LeanCustomization?, success: {
                    print("Entity Connected")
                    isPresented = false
                }, error: { (status) in
                    print(status.status)
                    print(status.message)
                    print(status.method)
                    isPresented = false
                })
        isPresented = true
    }
}

3. Call a method

You can now write and attach functions to any UI element using Lean.manager.[method] see Methods section below

4. Handle success and error closures

You can write your own completion blocks upon success and failure of the LinkSDK.

Errors will pass back a LeanStatus dictionary with the following:

{
    status: "ERROR",
    method: "CONNECT",
    message: "Some message"
}

Usage with View Controllers

Initalizing

Call Lean.manager.setup(appToken, sandbox, version) during ViewDidLoad - or before attempting to make a call to the SDK.

// ViewController.swift

import UIKit
import LeanSDK

class ViewController: UIViewController {

    override func ViewDidLoad() {
        super.viewDidLoad()
        Lean.manager.setup(appToken: String, sandbox: true, version: "latest")
    }
}

Call a method

You can now write and attach functions to any UI element using Lean.manager.[method] see Methods section below.

Ensure that you set the presentingViewController, to the View Controller that you want the SDK to present within.

// ViewController.swift

import UIKit
import LeanSDK

class ViewController: UIViewController {
    var connectPermissions = [LeanPermission.Identity, LeanPermission.Accounts,
                              LeanPermission.Transactions, LeanPermission.Balance]

    override func ViewDidLoad() {
        super.viewDidLoad()
        Lean.manager.setup(appToken: String, sandbox: true, version: "latest")
    }
}
    @IBAction func handleConnect(_sender: Any) {
        Lean.manager.connect(
            presentingViewController: self,
            customerId: String,
            permissions: connectPermissions,
            bankId: nil,
            customization: LeanCustomization?,
            success: { status in
                print("Entity Connected")
            }, error: { (status) in
                print(status)
            }
        )
    }

Handle success and error closures

You can write your own completion blocks upon success and failure of the LinkSDK.

Errors will pass back a LeanStatus dictionary with the following:

{
    status: "ERROR",
    method: "CONNECT",
    message: "Some message"
}

Available Methods

.connect()

The connect method is used to enable a customer to use a single log in to create and Entity and a PaymentSource for use with the Data API and Payments API respectively.

Lean.manager.connect(
    customerId: String,
    permissions: ArrayOf<LeanPermission>,
    paymentDestinationId: String,
    bankId: String?
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
)

.reconnect()

The reconnect method is used to re-authenticate a customer account with the Data API.

Lean.manager.reconnect(
    reconnectId: String,
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
)

.createBeneficiary()

The createBeneficiary method is used to authorize an additional payment destination for an existing payment source in the Payments API.

NOTE: We have renamed the updatePaymentSource() method on the Link SDK. It will now be called createBeneficiary(). The updatePaymentSource() method is now deprecated. Please use the new method as detailed below.

Lean.manager.updatePaymentSource(
    customerId: String,
    paymentSourceId: String,
    paymentDestinationId: String,
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
)

.pay()

The pay method is used to make a bank to bank transfer from your customer's account to your account in the Payments API.

Lean.manager.pay(
    paymentIntentId: String,
    accountId: String?
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
)

The show_balances parameter is optional and allows you to show/hide the balances of bank accounts when an end user is going through the payment authorization flow. It's RECOMMENDED to always "HIDE" the balances.

📘

Attention!

The authorize() method only applies to the Corporate Payment flow.

.authorize()

Lean.manager.authorize({
  	paymentIntentId: String,
    customerId: String,
  	endUserId: String,
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
});

Callback functions

The iOS SDK takes an optional parameter for callback which allows you to receive events on SDK close, completion or error.

Response

The responseObject returned to your callback function is in the following format:

{
  "status": "SUCCESS",
  "message": "User successfully connected their account",
  "last_api_response": "SUCCESS",
  "exit_point": "SUCCESS",
  "secondary_status": "SUCCESS",
  "bank": {
    "bank_identifier": "LEANMB1",
    "is_supported": true
  }
}

status enum
The end status of the LinkSDK at close.

StatusReason
SUCCESSThe initiated flow was completed successfully
CANCELLEDThe initiated flow was cancelled by the user
ERRORThe SDK or user experienced an error - the details for the error are available in the message and secondary_status.

message string

Further details on the end state. May be null.

last_api_response string

Details on the last response status from the Lean API. May be null.

exit_point enum

The last screen displayed before the user exited the SDK.

valuescreen
INITIALThe first screen displayed to users
RECONNECT_INITIALThe first screen displayed to users when using .reconnect()
BANK_SELECTIONThe bank list screen
OPEN_BANKINGOpen banking redirect initiation
CONSENTThe permissions screen
CREDENTIALSThe login detail entry screen
CREDENTIALS_UPDATEThe re-entry form for login details when credentials are outdated
MFAThe OTP entry screen
OPEN_BANKING_ENABLE_PAYMENTSOpen banking redirect initiation for payments
PAYMENT_SOURCESThe screen that lists all a user's payment sources prior to payment initiation
UPDATE_PAYMENT_SOURCEThe update payment source consent screen
PAYMENT_DETAILSThe payment initiation screen
SECURITY_QUESTIONThe security question answer form
MFA_INSTRUCTIONSThe instructions for entering an OTP
UNSUPPORTED_BANK_REQUESTThe unsupported bank list screen
SUCCESSThe success screen
FAILThe failure screen

secondary_status enum

Further details on failures e.g. INVALID_CREDENTIALS. May be null.

bank object

Details on the bank selected by the user.

bank.bank_identifier enumThe Lean identifier for the bank.
bank.is_supported boolWhether the bank is supported by Lean or not (is false when a user selects a bank through the 'My bank is not listed' button)

Unsupported banks

Your users can indicate that their bank is not supported. When this happens, the callback from the LinkSDK will contain a false flag in the bank object.

{
  "status": "CANCELLED",
  "message": "User cancelled the operation",
  "exit_point": "UNSUPPORTED_BANK_REQUEST_SUCCESS",
  "last_api_response": "CANCELLED",
  "secondary_status": "CANCELLED",
  "bank": {
    "bank_identifier": "AHB_UAE",
    "is_supported": false
  }
}

Skip Bank List

In some use cases you may want to provide your own UI for the bank selection screen in the LinkSDK. This can be achieved by passing in a bank_identifier during the .connect() flow.

You can get a list of available bank_identifiers for your application by making a call to the /banks/ endpoint.

Call:

curl -X GET 'https://api.leantech.me/banks/v1/' \
  --header 'lean-app-token: 2c9a80897169b1dd01716a0339e30003'

Response:

[
    {
        "id": 13,
        "identifier": "FAB_UAE",
        "name": "First Abu Dhabi Bank",
        "main_color": "#ffffff",
        "background_color": "#00458A",
        "theme": "light",
        "country_code": "UAE",
        "active": true,
        "traits": [
            "user-input-on-login",
            "auth-credentials"
        ],
        "supported_account_types": [
            "CREDIT",
            "SAVINGS",
            "CURRENT"
        ]
    },
    {
        "id": 12,
        "identifier": "LEANMB1",
        "name": "Lean Mock Bank",
        "main_color": "#FDB813",
        "background_color": "#06357A",
        "theme": "light",
        "country_code": "UAE",
        "active": true,
        "traits": [
            "auth-credentials"
        ],
        "supported_account_types": [
            "CREDIT",
            "SAVINGS",
            "CURRENT"
        ]
    }

You can then use the bank identifier directly with the LinkSDK to skip the bank selection screen:

Lean.manager.connect(
    customerId: String,
    permissions: ArrayOf<LeanPermission>,
    paymentDestinationId: String,
    bankId: String?,
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
)

Skip Payment Source selection

In Some use cases, you may want to render your own list of Payment Sources - or have business logic around which payment source can be used to make a specific payment. In these cases, you can pass the accounts[n].id parameter from a Customer's Payment Source into the LinkSDK to skip the selection screen within the SDK.

How to get Payment Sources for a Customer 

Lean.manager.pay(
    paymentIntentId: String,
    accountId: String? //if you add the account ID the payment source will be skipped
    customization: LeanCustomization?,
    success: () -> (),
    error: (status) -> ()
)

Changing the SDK language

Link SDK is available in English and Arabic, fully supported with a right-to-left UI, including text alignment, icons and images. If no language is provided the default is English. The language parameter is provided to the Lean.manager.setup

...
Lean.manager.setup(
    language: String,
    ...
)

Language option

language enum

enEnglish
arArabic

Customizing Link SDK

We are progressively releasing customization capabilities to the Link SDK to match its UI with your application branding style. This allows customers to programmatically theme the Link SDK directly from any of the methods.

For more detailed documentation on how best to use the customization feature see our guides.

Customisation Guide

Presentation options

dialog_mode string

Presents the Link SDK with or without a containing modal.

"contained" for modal (default), or "uncontained" for no modal.

button_border_radius string

Change the shape of the main button on each step. See guidance for examples.

A unitless number as a String. Options:

ValueStyle
"4"default
"8"Border radius of 8px
"0"Rectangle button
"pill"Always pill shaped, whatever the button height

Color options

theme_color string

Buttons background color, active input borders, and loading spinners.

button_text_color string

Elements inside any primary button such as the text, icons and the loading spinner. It is useful to boost readability of the button color.

link_color string

CTAs and helpers.

overlay_color string

Overlay containing the Link SDK dialog box.

The following color formats are supported:

ExampleFormat
"#000000"Hex
"#000"Shorthand hex
"#000000FF"Hex with alpha
"rgb(0, 0, 0)"Comma separated RGB
"rgba(0, 0, 0, 0.5)"Comma separated RGB with Alpha
"black"Color name

Example

var customConfig = LeanCustomization(
    dialogMode: String?, 
    themeColor: String?, 
    buttonTextColor: String?,
    buttonBorderRadius: String?,
    linkColor: String?, 
    overlayColor: String?
)

Lean.manager.connect(
    customerId: String,
    permissions: ArrayOf<LeanPermission>,
    paymentDestinationId: String,
    bankId: String?
    customization: customConfig,
    success: () -> (),
    error: (status) -> ()
)

Updated 4 months ago