OB-SERVICE-JSCLIENT

JavaScript client for communicating with the OB (Open Banking) API by loyalBe. Written in TypeScript with Node 12.x.

Installation

Package currently hosted in a private GitLab repo; so installation is advised as follows:

npm install --save git+ssh://[email protected]:loyalbe/ob-service-jsclient.git

Usage of SSH to avoid leaking access tokens. Might need to build locally and transfer node modules across to places it's needed, i.e. docker container.

Usage

Below is an example of using the client to get the bank redirect url which will be used by an end user to authorise consent.

const {Client} = require('ob-service-jsclient');

const client = new Client({
		clientId: '<client_id>',
		clientSecret: '<client_secret>'
});
	
try {
	let response = await client.getAuthUrl({
		redirectUri: '<redirectUri>',
		bankIdentifier: '<bankIdentifier>'
	});
	
	// response.authUrl will be the bank AUTH url that you can send to user	
} catch (e) {

}

## Available features

• getAuthUrl: For getting bank redirect to allow end user to authorise consent,
• exchangeCode: For exchanging the code, state and id token which is sent back to the redirect URI provided in the getAuthUrl request.
• getConsentDetails: For getting details of the consent status, i.e. check if it's still authorised etc.

More coming soon...