Okra Widget Flutter SDK

alt text

Flutter SDK for implementing the Okra widget - Okra is a safe and secure web drop-in module and this library provides a front-end web (also available in iOS, Android, and JavaScript) SDK for account authentication and payment initiation for each bank that Okra supports.

Try the demo

Checkout the widget flow to view how the Okra Widget works. Click "See How it Works"

Before getting started

  • Checkout our get started guide to create your developer account and retrieve your Client Token, API Keys, and Private Keys.
  • Create a sandbox customer, so you can get connecting immediately.

Bonus Points

  • Setup Slack Notifications so you can see your API call statuses and re-run calls in real-time!

Getting Started

This library would help you add Okra widget to your hybrid android/ios application in no time. All you need to do is ...

Install

To use this plugin, add okra_widget as a dependency in your pubspec.yaml file.

dependencies:
  okra_widget: ^3.1.6

On iOS, opt-in to the embedded views preview and also enable Arbitrary loads by adding the following configs to the app's Info.plist file

    <key>io.flutter.embedded_views_preview</key>
	<string>YES</string>
	<key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
        <key>NSAllowsArbitraryLoadsInWebContent</key>
        <true/>
    </dict>

Usage

Build with options

var banks = [
                    "ecobank-nigeria",
                    "fidelity-bank",
                    "first-bank-of-nigeria",
                    "first-city-monument-bank",
                    "guaranty-trust-bank",
                    "access-bank",
                    "unity-bank",
                    "alat",
                    "polaris-bank",
                    "stanbic-ibtc-bank",
                    "standard-chartered-bank",
                    "sterling-bank",
                    "union-bank-of-nigeria",
                    "united-bank-for-africa",
                    "wema-bank",
                    "rubies-bank",
                    "kuda-bank"
                  ];

                  Okra.buildWithOptions(context,
                                        key: "3f52ee9d-f081-55a7-a9d8-73d4b5878bd2",
                                        token: "5da6358130a943486f33dced",
                                        color: "#3AB795",
                                        products: ['auth', 'identity', 'balance', 'transactions'],
                                        chargeAmount: 1000,
                                        chargeNote: "testing",
                                        chargeType: "one-time",
                                        chargeCurrency: "NGN",
                                        environment: "production",
                                        clientName: "clientName",
                                        customerBvn: "22188789177",
                                        meta: "Dynamic data type",
                                        options: {
                                          "name": "Test Map"
                                        } 
                                        logo:
                                            "https://dash.okra.ng/static/media/okra-logo.514fd943.png",
                                        limit: 3,
                                        currency: "NGN",
                                        isCorporate: false,
                                        showBalance: true,
                                        geoLocation: true,
                                        payment: false,
                                        connectMessage:
                                            "Which account do you want to connect with?",
                                        callbackUrl: "",
                                        redirectUrl: "",
                                        widgetSuccess:
                                            "Your account was successfully linked to SwipeNG",
                                        widgetFailed:
                                            "An unknown error occurred, please try again.",
                                        guarantors: {
                                          "status": false,
                                          "message": "Okra requires you to add guarantors",
                                          "number": 3,
                                        },
                                        filters: {"industry_type": "all", "banks": banks},
                                        onSuccess: (data) {
                                      print("Success");
                                      print(data);
                                    }, onError: (message) {
                                      print("error");
                                      print(message);
                                    }, onClose: (message) {
                                      print("close");
                                      print(message);
                                    });

Build with shortUrl


                Okra.buildWithShortUrl(
                        context,
                        shortUrl: "ns_aIEz8r",
                        onSuccess: (data) {
                          print("Success");
                          print(data);
                        },
                        onError: ( message) {
                          print("error");
                          print(message);
                        },
                        onClose: (message) {
                          print("close");
                          print(message);
                        }
                    );

OkraOptions

Name Type Required Default Value Description
key String true undefined Your public key from Okra.
token String true undefined Your pubic Key from Okra dashboard. Use test key for test mode and live key for live mode
products ArrayList<Enums.Product> true undefined The Okra products you want to use with the widget.
env Enums.Environment true undefined
clientName String true undefined Name of the customer using the widget on the application
webhook String true undefined The Url that Okra send the client's data to.

Data Dictionary

Auth

Field Required Description
id
ObjectID		 Yes Unique Auth ID (Unique Okra Identifier)
validated
Boolean		 Yes Customer authentication status
bank
ObjectID		 Yes Unique Bank ID (Unique Okra Identifier)
customer
ObjectID		 Yes Unique Customer ID (Unique Okra Identifier)
record
ObjectID		 Yes Unique Record ID (Unique Okra Identifier)
owner
ObjectID		 Yes Unique Company ID (Unique Okra Identifier) (Your Client Token)
created_at
Object		 Yes Date Auth was fetched
last_updated
Object		 Yes Last Date Auth was fetched

Balance

Field Required Description
id
ObjectID		 Yes Unique Balance ID (Unique Okra Identifier)
available_balance
Integer		 Yes Amount of available funds in account
ledger_balance
Integer		 Yes Closing balance of account
currency
String		 Yes The currency of the account
connected
Boolean		 Yes Customer connection status (Did they choose to connect this account to you)
env
String		 Yes Okra API Env the transaction was pulled from production or production-sandbox
bank
ObjectID		 Yes Unique Bank ID (Unique Okra Identifier)
accounts
ObjectID		 Yes Unique Account ID (Unique Okra Identifier)
customer
ObjectID		 Yes Unique Customer ID (Unique Okra Identifier)
record
Array of ObjectID		 Yes Unique Record ID (Unique Okra Identifier)
created_at
Object		 Yes Date Balance was fetched
last_updated
Object		 Yes Last Date Balance was fetched

Identity

Field Required Description
id
ObjectID		 Yes Unique Identifier ID (Unique Okra Identifier)
firstname
String		 Yes Customer First Name
middlename
String		 Yes Customer Middle Name
lastname
String		 Yes Customer Last Name
next_of_kins
Identity Object		 Yes Customer Next of Kins
dob
Date		 Yes Customer Date of Birth
verified
String		 Yes BVN Validation status
score
String		 Yes Unique Okra Score
dti
String		 Yes Customer Debt to Income Score
fullname
String		 Yes Customer Fullname
company_name
String		 **Yes Company Name if Corporate Identity
nin
String		 Yes Customer NIN Number
national_id
String		 Yes Customer National ID Number
drivers_lisence
String		 Yes Customer Driver's License Number
nimc
String		 Yes Customer National Identity Management Commission (NIMC) Number
voters_id
String		 Yes Customer Voter's ID Number
rc_number
String		 Yes Company's Registered Company Number if Corporate Identity
phone
Array of String		 Yes Customer Phone Number
last_login
String		 Yes Customer Last Login via Okra
email
Array of String		 Yes Customer Email address
address
Array of String		 Yes Customer
mothers_maiden
String		 Yes Customer Mother's Maiden Name
photo_ids
Array of Object		 Yes Customer's photo ID
env
String		 Yes Okra API Env the transaction was pulled from production or production-sandbox
bank
ObjectID		 Yes Unique Bank ID (Unique Okra Identifier)
accounts
ObjectID		 Yes Unique Account ID (Unique Okra Identifier)
customer
ObjectID		 Yes Unique Customer ID (Unique Okra Identifier)
record
Array of ObjectID		 Yes Unique Record ID (Unique Okra Identifier)
created_at
Object		 Yes Date Balance was fetched
last_updated
Object		 Yes Last Date Balance was fetched

Transaction

Field Required Description
id
ObjectID		 Yes Unique Transaction ID (Unique Okra Identifier)
debit
Integer		 No Amount deducted from account
credit
Integer		 No Amount credited to account
trans_date
Date		 Yes Date transaction occurred
cleared_date
Date		 Yes Date transaction cleared at bank
unformatted_trans_date
String		 Yes Date transaction occurred (from bank)
unformatted_cleared_date
String		 Yes Date transaction cleared (from bank)
branch
String		 No Branch transactions occurred
ref
String		 No Bank reference ID (from bank)
env
String		 Yes Okra API Env the transaction was pulled from production or production-sandbox
code
String		 No Bank Code (from bank)
benefactor
ObjectID		 No Customer ID of sender (within Okra)
code
String		 No Bank Code (from bank)
notes
Object		 Yes Breakdown of Narrative from bank
bank
ObjectID		 Yes Unique Bank ID (Unique Okra Identifier)
account
ObjectID		 Yes Unique Account ID (Unique Okra Identifier)
record
Array of ObjectID		 Yes Unique Record ID (Unique Okra Identifier)
created_at
Object		 Yes Date transactions was fetched
last_updated
Object		 Yes Last Date transactions was fetched

Notes Data Dictionary

Field Required Description
desc
String		 Yes Narrative / Description of transaction (combination of bank and user entered information)
topics
Array of String		 Yes Topics within the desc
places
Array of String		 Yes Places mentioned within the desc
people
Array of String		 Yes People mentioned within the desc
actions
Array of String		 Yes Actions mentioned within the desc
subject
Array of String		 Yes Subject of the desc
preposition
Array of String		 Yes Prepositions within desc to understand intent

Libraries

helper
okra
okra_handler
okra_html
okra_widget
web