Vue-okra NPM | npm.io

okra-vuejs

This is an vue module that abstracts the complexity of using okra with vue.

USAGE

1. Install the module

npm install --save vue-okra

2. Import the module

In your app.vue or any module where the component would be used like so:

<script>
import OkraButton from "vue-okra/src/components/OkraButton";

export default {
  name: "app",
  components: {
    OkraButton
  },
  methods: {
    success: function() {
      window.console.log("okra success");
    },
    close: function() {
      window.console.log("okra closed");
    }
  }
};
</script>

3. Implement in your project

VueOkraComponent: Renders a button which when clicked loads okra Inline

  <OkraButton
    text="Open Okra"
  token="5d8a35224d8113507c7521ac"
  env="production"
  client-name="Chikala"
  okra-key="c81f3e05-7a5c-5727-8d33-1113a3c7a5e4"
  callback-url="www.google.com"
  color="#b0c77f"
  limit="24"
  :corporate="false"
  connect-message=""
  redirect-url=""
  logo=""
  widget-success=""
  currency=""
  exp=""
  success-title=""
  success-message=""
  :guarantors="{'status': false, 'message': 'Please add your gaurantor','number': '2'}"
  :filter= "{'industry_type':'all','banks':['ecobank-nigeria','fidelity-bank','first-bank-of-nigeria','first-city-monument-bank','guaranty-trust-bank','heritage-bank','polaris-bank','stanbic-ibtc-bank','standard-chartered-bank','sterling-bank','union-bank-of-nigeria','united-bank-for-africa','wema-bank','unity-bank','alat','access-bank']}"
  :close="close"
  :success="success"
  :options="{fullname: 'USER_FULL_NAME', email: 'USER_EMAIL', bvn: 'USER_BVN'}"
  :products="['auth', 'transactions', 'balance', 'income', 'identity']"
  />

And then in your component.ts

  <script>
import OkraButton from "./components/OkraButton.vue";

export default {
  name: "app",
  components: {
    OkraButton
  },
  methods: {
    success: function() {
      window.console.log("okra success");
    },
    close: function() {
      window.console.log("okra closed");
    }
  }
};
</script>

OkraOptions

Name	Type	Required	Default Value	Description
`callback_url`	`string`	true	undefined	This is your webhook to which okra sends the clients data to.
`key`	`String`	true	undefined	Your public key from Okra.
`token`	`String`	true	undefined	Your client token on the setting page of the okra dashboard
`products`	`ArrayList<Enums.Product>`	true	undefined	The Okra products you want to use with the widget. list of products include: 'auth', 'transactions', 'balance', 'income', 'identity'
`env`	`String`	true	https uses `production` and http uses `sandbox-production`	`production` or `production-sandbox`
`clientName`	`String`	false	`This client`	Name of the customer using the widget on the application
`user`	`object`	false	undefined	This contains some information of the user using the okra widget {fullname: 'USER_FULL_NAME',email: 'USER_EMAIL', bvn: 'USER_BVN'}

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