Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

okraHQ/okra-ios-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
Example
Example
 
 
OkraWidget
OkraWidget
 
 
.gitignore
.gitignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
OkraWidget.podspec
OkraWidget.podspec
 
 
README.md
README.md
 
 
_Pods.xcodeproj
_Pods.xcodeproj
 
 

Repository files navigation

okra-ios-sdk

This is an ios library for implementing okra widget

Get Started

This library would help you add Okra widget to you native ios app in no time.

Install

  1. Clone the repository and save to a location:
$ git clone https://github.com/okraHQ/okra-ios-sdk.git

  1. Build and run the project via Xcode this creates a library build named "OkraWidget.framework" in the Products folder located at the root directory.

  2. Copy the file OkraWidget.framework to the root directory of the project you want to use it in.

  3. Go to project > General > Frameworks,Libraries, and Embedded Content and add the "OkraWidget.framework"

Usage

//Okra.create() static method takes in a UIViewController parameter and also and OkraOption parameter
let okraOptions = OkraOptions(isWebview: true, key: "c81f3e05-7a5c-5727-8d33-1113a3c7a5e4", token: "5d8a35224d8113507c7521ac", products: ["auth","transactions"], env: Environment.sandbox, clientName: "Basey")
Okra.create(baseController: self, okraOptions : okraOptions)

OkraOptions

Name Type Required Default Value Description
isWebview boolean true true
key String true undefined Your public key from Okra.
token String true undefined Your client token key from Okra.
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

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

11 watching

Forks

2 forks
Report repository

Releases 5

Release For Cocoapods Latest
Jan 15, 2021
4 releases

Packages

No packages published

Contributors 5

Languages