rn-truelayer-payments-sdk v2.1.0

TrueLayer Payments SDK

TrueLayer's React Native 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.

Table of Contents

1. How to Install the SDK
2. Setup
3. Prerequisites
   1. Setting Up Your Backend
   2. Minimum Versions
4. How to Use the SDK

How to Install the SDK

Yarn

yarn add rn-truelayer-payments-sdk

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 Versions

• Xcode 14.x and iOS 14.0.
• Android 7.0 (API level 24)

How to Use the SDK

1. Configure the SDK with the given environment (Environment.Sandbox or Environment.Production):

   TrueLayerPaymentsSDKWrapper.configure(Environment.Sandbox).then(
           () => {
                  console.log('Configure success')
           },
           reason => {
                   console.log('Configure failed ' + reason)
           },
   )