Skip to content

Latest commit

 

History

History
350 lines (274 loc) · 11 KB

README.md

File metadata and controls

350 lines (274 loc) · 11 KB
Raw

Mono Connect.js

Mono Connect.js is a quick and secure way to link bank accounts to Mono from within your app. Mono Connect is a drop-in framework that handles connecting a financial institution to your app (credential validation, multi-factor authentication, error handling, etc). It works with all major javascript frameworks.

For accessing customer accounts and interacting with Mono's API (Identity, Transactions, Income, DirectPay) use the server-side Mono API.

Version 2.0.2 Public Beta

Important: Version 2.0.2 is currently in the public beta phase. This means it's available for testing and feedback from the community. Please be aware that there may be bugs, and some features might undergo changes before the stable release.

How to Install the Beta Version

To try out the beta version, use the following command:

npm install @mono.co/connect.js@2.0.2

Documentation

For complete information about Mono Connect, head to the docs.

Requirements

Node 10 or higher.

Getting Started

  1. Register on the Mono website and get your public and secret keys.
  2. Setup a server to exchange tokens to access user financial data with your Mono secret key.

Installation

You can install the package using NPM or Yarn;

npm install @mono.co/connect.js

or

yarn add @mono.co/connect.js

Then import it into your project;

import Connect from '@mono.co/connect.js'

Usage

Click the links below for detailed examples on how to use connect.js with your favorite framework;

NOTE
The list above is not exhaustive, you can use this package in other frontend javascript frameworks.

Parameters

key

Required
This is your Mono public API key from the Mono dashboard.

new Connect({ key: 'mono_public_key', scope: 'auth' });

Customer

Required

// you can pass id of an existing mono customer
// const customer = { id: '611aa53041247f2801efb222' } // mono customer id

// or create a new mono customer
const customer = {
  name: 'Samuel Olumide',
  email: 'samuel.olumide@gmail.com',
  identity: {
    type: 'bvn',
    number: '2323233239'
  },
}

new Connect({ 
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
});

onSuccess

Required This function is called when a user has successfully onboarded their account. It should take a single String argument containing the token that can be exchanged for an account id.

new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: (data) => {
    // in the case of authentication auth code is returned
    console.log("auth code", data.code);
    // in the case of direct debit payments
    // a charge object is return containing amount, transaction_reference, type...
    console.log("charge object", data);
  }
});

onClose

The optional closure is called when a user has specifically exited the Mono Connect flow (i.e. the widget is not visible to the user). It does not take any arguments.

new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("auth code", code),
  onClose: () => console.log("widget has been closed")
});

onLoad

This function is invoked the widget has been mounted unto the DOM. You can handle toggling your trigger button within this callback.

new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("auth code", code),
  onLoad: () => console.log("widget loaded successfully")
});

onEvent

This optional function is called when certain events in the Mono Connect flow have occurred, for example, when the user selected an institution. This enables your application to gain further insight into the Mono Connect onboarding flow.

See the data object below for details.

new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("auth code", code),
  onEvent: (eventName, data) => {
    console.log(eventName);
    console.log(data);
  }
});

reference

This optional string is used as a reference to the current instance of Mono Connect. It will be passed to the data object in all onEvent callbacks. It's recommended to pass a random string.

new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("auth code", code),
  reference: "some_random_string"
});

setupConfig

This optional configuration object is used as a way to load the Connect Widget directly to an institution login page.

const config = {
  selectedInstitution: {
    id: "5f2d08c060b92e2888287706", // the id of the institution to load
    auth_method: "internet_banking" // internet_banking or mobile_banking
  }
}

connect.setup(config);

API Reference

setup(config: object)

This method is used to load the widget onto the DOM, the widget remains hidden after invoking this function until the open() method is called.

It also allows an optional configuration object to be passed. When the setup method is called without a config object, the list of institutions will be displayed for a user to select from.

const connect = new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("code", code),
  onLoad: () => console.log("widget loaded successfully"),
  onClose: () => console.log("widget has been closed"),
  onEvent: (eventName, data) => {
    console.log(eventName);
    console.log(data);
  },
  reference: "random_string"
});

const config = {
  selectedInstitution: {
    id: "5f2d08c060b92e2888287706",
    auth_method: "internet_banking"
  }
}

connect.setup(config);

reauthorise(reauth_code: string)

This methods loads the reauth widget unto the DOM, the widget remains hidden after invoking this function until the open() method is called.

Reauthorisation of already authenticated accounts is done when MFA (Multi Factor Authentication) or 2FA is required by the institution or it has been setup by the user for security purposes before more data can be fetched from the account.

Check Mono docs on how to obtain reauth_code of an account.

const connect = new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  onSuccess: ({code}) => console.log("code", code),
});
connect.reauthorise("auth_fb8PP3jYA0");
Parameter Type Description
reauth_code string Required. Reauth code of the account to be reauthorised

NOTE
the reauthorise method and setup method should be used separately. When used together, the last called method takes precedence.

open()

This method makes the widget visible to the user.

const connect = new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("code", code),
});

connect.setup();
connect.open();

close()

This method programatically hides the widget after it's been opened.

const connect = new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("code", code),
});

connect.setup();
connect.open();

// this closes the widget 5seconds after it has been opened
setTimeout(() => connect.close(), 5000)

onEvent Callback

The onEvent callback returns two paramters, eventName a string containing the event name and data an object that contains event metadata.

const connect = new Connect({
  key: 'mono_public_key',
  scope: 'auth',
  data: { customer },
  onSuccess: ({code}) => console.log("code", code),
  onEvent: (eventName, data) => {
    if(eventName == "OPENED"){
      console.log("Widget opened");
    }else if(eventName == "INSTITUTION_SELECTED"){
      console.log("Selected institution: "+data.institution.name);
    }
    console.log(eventName)
    console.log(data)
  }
});

eventName

Event names corespond to the type key returned by the raw event data. Possible options are in the table below.

Event Name Description
OPENED Triggered when the user opens the Connect Widget.
EXIT Triggered when the user closes the Connect Widget.
INSTITUTION_SELECTED Triggered when the user selects an institution.
AUTH_METHOD_SWITCHED Triggered when the user changes authentication method from internet to mobile banking, or vice versa.
SUBMIT_CREDENTIALS Triggered when the user presses Log in.
ACCOUNT_LINKED Triggered when the user successfully links their account.
ACCOUNT_SELECTED Triggered when the user selects a new account.
ERROR Triggered when the widget reports an error.

data

The data object returned from the onEvent callback.

{
  "reference": "ref_code_passed", // emitted in all events
  "errorType": "ERORR_NAME", // emitted in ERROR
  "errorMessage": "An error occurred.", // emitted in ERORR
  "mfaType": "OTP", // emitted in SUBMIT_MFA
  "prevAuthMethod": "internet_banking", // emitted in AUTH_METHOD_SWITCHED
  "authMethod": "mobile_banking", // emitted in AUTH_METHOD_SWITCHED and INSTITUTION_SELECTED
  "pageName": "MFA", // emitted in EXIT
  "selectedAccountsCount": 2 // emitted in ACCOUNT_SELECTED
  "institution": { // emitted in ACCOUNT_LINKED and INSTITUTION_SELECTED
    "id": "66059eO033be88012",
    "name": "GTBank"
  },   
  "timestamp": 1234567890 // emitted in all events
}

Support

If you're having general trouble with Mono Connect.js or your Mono integration, please reach out to us at hi@mono.co or come chat with us on Slack. We're proud of our level of service, and we're more than happy to help you out with your integration to Mono.

Contributing

If you find any issue using this package please let us know by filing an issue right here.

If you would like to contribute to the Mono Connect.js, please make sure to read our contributor guidelines.

License

MIT for more information.