TrueLayer Payments SDK

TrueLayer's iOS SDK allows you to quickly add open banking payments to your app. The SDK integrates with TrueLayer's Payments API, making it simple to get up and running.

The SDK presents native screens that allow your users to select their bank and consent to the payment. The user is then redirected to their banking app or website to authorise the payment. It also handles the network requests and errors, and gives you options to customise the user interface.

The Android version of the SDK can be found here.

Note: If you are migrating from the beta version of the iOS SDK, checkout this Migration Guide.

Table of Contents

1. How to Install the SDK
   1. SwiftPM
   2. Cocoapods
2. Setup
   1. Prerequisites
      1. Setting Up Your Backend
      2. Minimum Xcode and iOS Versions
3. How to Use the SDK
   1. Starting the SDK
   2. Processing a Payment
   3. Preferences
   4. Styling
4. How to Report Issues

How to Install the SDK

SwiftPM

To install the SDK using Swift Package Manager:

1. Open your app in Xcode.
2. In the Project Navigator, click on the project.
3. Click File > Add Packages...
4. Insert the https://github.com/truelayer/truelayer-ios-sdk URL in the search bar and click Enter.
5. Click on the Add Package button.
6. Follow the dialog to install the SDK.

CocoaPods

To install the SDK via Cocoapods, specify TrueLayerPaymentsSDK in your Podfile:

pod 'TrueLayerPaymentsSDK'

Setup

Prerequisites

Setting Up Your Backend

• Create an account in the TrueLayer console. Follow this guide to set it up correctly.

• You need a backend which is able to retrieve an access token and create a payment on behalf of the user. This is to enforce security on the client, avoiding the need to store static secrets in your app. The API documentation can be found here.

Finally, your app should setup a payment. Once the payment has been setup, it is possible to delegate all the remaining parts of the process to the SDK. To set up a payment, the backend should:

1. Authenticate with TrueLayer.
2. Create a Payment.
3. Return the payment identifier and the resource token to the app.

Minimum Xcode and iOS Versions

The iOS SDK has the following requirements:

• Xcode 14.x
• Swift 5.9
• iOS 14.0

How to Use the SDK

1. Import the SDK:

    import TrueLayerSDK
   

2. Configure the SDK with the given environment:

    Task {
      TrueLayer.Payments.manager.configure(environment: .sandbox)
    }
   

3. Checkout Documentation

Styling

You can style the SDK to match your app's UI. See Styling.