mono_flutter 3.0.4 mono_flutter: ^3.0.4 copied to clipboard
A Flutter plugin integrating the official android and ios SDK for Mono https://withmono.com
mono_flutter #
A Flutter plugin integrating the official android and ios SDK for Mono (financial data Platform) (https://withmono.com/)
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 on mobile and web.
For accessing customer accounts and interacting with Mono's API (Identity, Transactions, Income, DirectPay) use the server-side Mono API. For complete information about Mono Connect, head to the docs. https://docs.withmono.com/docs/ .
Getting Started #
Register on the Mono website and get your public and secret keys. Setup a server to exchange tokens to access user financial data with your Mono secret key.
How to upgrade to the Mono Widget 2.0 #
If you already use Mono Connect or DirectPay, you will need to upgrade your widget to version 2 to get access to these new features. To upgrade to v2, take the following steps:
Log in to your Mono dashboard
Visit Preferences in the Settings section, toggle on the new version of the Mono widget, and confirm the switch.
If you would like to use the new widget and Mono's open banking APIs to build innovative solutions for your customers, you can get started by creating a Mono account here.
screenshots
Preview #
you can checkout a web preview here https://wiseminds.github.io/mono-flutter
Usage #
Import package:mono_flutter/mono_flutter.dart
and use the methods in MonoFlutter
class.
For web support add the following to index.html :
<script src="https://connect.withmono.com/connect.js"></script>
<script>
function setupMonoConnect(key, reference, data, authCode, scope) {
const configJson = JSON.parse(data ?? `{}`);
const options = {
key,
reference,
scope,
onSuccess: onSuccess,
onEvent: onEvent,
onClose: onClose,
onLoad: onLoad
};
const MonoConnect = new Connect(options);
MonoConnect.setup(configJson);
if(authCode && String(authCode).length > 0) {
MonoConnect.reauthorise(authCode);
}
MonoConnect.open()
}
</script>
Example:
import 'package:mono_flutter/mono_flutter.dart';
void main() async {
runApp(App());
}
class App extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Center(
child: RaisedButton(
child: Text('launch mono'),
onPressed: () {
MonoFlutter().launch(
context,
'YOUR_PUBLIC_KEY_HERE',
// authCode: 'code_sGjE1Zh48lFR8vr3FkrD',
reference: DateTime.now().millisecondsSinceEpoch.toString(),
scope: "auth", // NEWLY INTRODUCED
data: // NEWLY INTRODUCED
jsonEncode({
"customer": {
"name": "Samuel Olamide", // REQUIRED
"email": "samuel@neem.com", // REQUIRED
"identity": {
"type": "bvn",
"number": "2323233239",
}
}
}),
onEvent: (event, data) {
print('event: $event, data: $data');
},
onClosed: (code) {
print('Modal closed, $code');
},
onLoad: () {
print('Mono loaded successfully');
},
onSuccess: (code) {
print('Mono Success $code');
},
);
}
}
// FOR NEW CUSTOMERS
"customer": {
"name": "Samuel Olamide", // REQUIRED
"email": "samuel@neem.com", // REQUIRED
"identity": { // OPTIONAL
"type": "bvn",
"number": "2323233239",
}
}
// FOR RETURNING CUSTOMERS
"customer": {
"id": "623625362356125afdea1245" // REQUIRED
}
Checkout the example project for full implementation
###Reauthorization Passing the [authCode] to the launch command This package will automatically call [connect.reauthorise(authCode)]
connect.reauthorise(authCode);
Reauth code is a mono generated code for the account you want to re-authenticate, which must be requested by your server and sent to your frontend where you can pass it to mono connect widget. Mono connect widget will ask for the required information and re-authenticate the user's account and notify your server. Once the reauthorisation is complete, the mono.events.account_reauthorized event will be sent to your webhook, following with mono.events.account_updated once the synced data is available.
Customizations #
For a custom page or with a dialog, use the [MonoFlutterWebView] widget, but this is not supported on the web.
showDialog(
context: context,
builder: (c) => MonoWebView(
key: "YOUR_APPS_PUBLIC_KEY_HERE",
scope: "auth", // NEWLY INTRODUCED
data: const { // NEWLY INTRODUCED
"customer": {
"name": "Samuel Olamide", // REQUIRED
"email": "samuel@neem.com", // REQUIRED
"identity": {
"type": "bvn",
"number": "2323233239",
}
}
},
onEvent: (event, data) {
print('event: $event, data: $data');
},
onClosed: () {
print('Modal closed');
},
onLoad: () {
print('Mono loaded successfully');
},
onSuccess: (code) {
print('Mono Success $code');
},
),
);