mono-logo

SDK Integration Guide

April 8th, 2024

Overview

This guide will put you through the necessary steps to take when trying to Integrate Mono Connect into your software solution. Please check out our populated list of SDKs in our documentation here for whichever platform you will want to integrate with, be it Android, Flutter, IOS or the Web.

For the sake of this guide, we will be integrating with our Inline Connect SDK.

Prerequisites

Prerequisites

To get started, please ensure to:

Integration Guide

With the above prerequisite steps already taken, please note that there are two stages for completing the integration process:

1. SDK Implementation (Front-end) Stage:

In this stage, you will be implementing a Mono SDK which allows your user or customer to log in to their selected or desired financial institution using the Mono widget on your mobile platform.

2. API Implementation (Back-end) Stage:

This is where you can start calling Mono's API for the user's bank account details, transactions, identity etc after a successful account authentication process.

We will be breaking down both stages in further detail below. For the sake of this guide, we will be integrating with our Inline Connect SDK.

SDK Implementation (Front-end) Stage

This stage aims to ensure that you have set up your desired Mono SDK in your mobile or web platform, so your users can successfully link their accounts on your platform. This can be achieved in two simple steps shared below:

1

Mono Connect Widget setup

Depending on the Mono SDK that you want to implement from our SDK directory here, be sure to go through the GitHub read-me doc for the installation and set up on your web or mobile platform as applied. Once done, update the key parameter to have your Mono application public key which you can retrieve from your dashboard.

It is this public key that identifies your mono dashboard app, to the front-end widget. Also, the SDK expects a required "data" callback which should contain the customer object

Note on Customer object

Note on Customer object

The structure of the expected fields on the customer object are:

  • name (required): This field expects the name of the customer
  • email (required): This field expects the email of the customer
  • identity: This object field expects both the identity type (i.e bvn) and the identity number
  • id: This field expects the customer id.

N.B: When an account has been linked successfully, an ID is generated for this customer, which can be accessible on the Mono dashboard.

With this newly generated customer id, it can be passed to the customer object directly, for subsequent account linking.

Request

12345678910111213141516171819
<script type="application/javascript">
  const customer = {
    id: "65c31fa54e0e963044f014bb", // When provided, the name, email and identity are not required.
    name: "Samuel Olamide", // required
    email: "samuel@neem.com", // required
    identity: {
      type: "bvn",
      number: "2323233239",
    },
  };

  var connect;
  var config = {
    key: "YOUR_APPS_PUBLIC_KEY_HERE"
    data: { customer },
  };
  connect = new Connect(config);
  connect.setup();
</script>

API Implementation (Back-end) Stage

At this point, the objective is to receive the temporary token from the front end, get your permanent Account ID and fetch the financial data APIs. All of these are explained in the steps below:

1

Fetch the Customer's Account ID

With our authorization token received from your front end, the next step to take here will be to call our Exchange Token API to fetch an Account ID for this user.

Please note that this Account ID is a permanent identifier to this user’s connected bank account. Also note that this Account ID doesn’t have an expiry time as the time to live is indefinite.

With this information at hand, it is important to save this Account ID into your database (which of course will be associated with this user linking) so that you can make future API calls as desired.

API Reference

Request

12345678910
curl --request POST \
  --url https://api.withmono.com/v2/accounts/auth \
  --header 'Content-Type: application/json' \
  --header 'accept: application/json' \
  --header 'mono-sec-key: test_sk_adasdsadasddasd' \
  --data '
{
    "code":"string"
}'

Request

123
{
  "id": "5f171a530295e231abca1153"
}

N.B: Kindly also note that once an account has been linked successfully on the Mono connect widget, an account connected (mono.events.account_connected) event is fired to your webhook URL, which you have setup on your dashboard, which informs you in real-time the account that has been linked.

You can visit here for more details about this webhook.

Request

123456
{
  event: "mono.events.account_connected",
  data: {
    "id": "5f171a530295e231abca1153"
  }
}
NOTE 1

NOTE 1

Regarding the expiry period

  • The Authorization token expires after 10 minutes.
  • The Account ID doesn't expire except if unlinked via API.
NOTE 2

NOTE 2

If you are integrating on the Web, please endeavor not to make this API request to Mono directly on your front end as you will be at risk of exposing your App Secret Key.

Instead, make an API request to your back-end with your payload and from there, you can now make an API call to Mono with your request.

Did this page help you?