okra-wp-plugin

Welcome to the Okra wordpress plugin repository on GitHub. Here you can browse the source, look at open issues and keep track of development.

Installation

1. Click on code and download repo (zip).

2. Go to Plugins > Add New and and click on the Upload Button at the top of the page, select the zipped repo and click Install Now, then click Activate Plugin the plugin.

3. The menu Okra would appear on the side menu with a blank Table.

Usage

To use the Okra Plugin, you must have generated a short url from the app builder on the okra dashboard. You can also find them on the apps page of the okra dashboard

1. Click on the Add New Button on top of the table
2. Fill in the infomation

Name	Description
Name	Name of the widget (This is just for idenitification).
Page	Page you want to use the widget on
Short Url	Your app short url
Button Text	Name of the customer using the widget on the application

3. Click Submit

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

Documentation

• https://docs.okra.ng/