Official Okra SDK for Android applications. Don't forget to star ✨
Okra’s API empowers companies and developers to build products with seamless access to inclusive financial data and secure payments.
Andoird SDK for implementing the OkraJS widget - OkraJS is a safe and secure web drop-in module and this library provides a front-end web (also available in iOS and Android) SDK for account authentication and payment initiation for each bank that Okra supports.
Checkout the widget flow to view how the Okra Widget works. Click "See How it Works"
- 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.
- If you are using the
buildWithShortURLversion, you will first need to create a link on your dashboard, and use theshort urlreturend at the end of the creation flow.
Bonus Points
- Setup Slack Notifications so you can see your API call statuses and re-run calls in real-time!
- Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
- Add the dependency:
dependencies {
implementation 'com.github.okraHQ:okra-android-sdk:v2.57'
}
val activityResultLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()
) {
if (it.resultCode == RESULT_OK && it.data != null) {
val okraResult = it.data!!.getStringExtra(OkraMainActivity.OKRA_RESULT)
//Successful operation, get the data and do whatever you want with it.
Toast.makeText(this, okraResult, Toast.LENGTH_SHORT).show()
} else {
val okraResult = it.data!!.getStringExtra(OkraMainActivity.OKRA_RESULT)
Toast.makeText(this, okraResult, Toast.LENGTH_SHORT).show()
}
}
val okraOptions = OkraOptions.ShortUrlBuilder("INSERT SHORT URL")
.build()
val intent = OkraMainActivity.newIntent(this, okraOptions)
activityResultLauncher.launch(intent)For options, just use
val activityResultLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()
) {
if (it.resultCode == RESULT_OK && it.data != null) {
val okraResult = it.data!!.getStringExtra(OkraMainActivity.OKRA_RESULT)
//Successful operation, get the data and do whatever you want with it.
Toast.makeText(this, okraResult, Toast.LENGTH_SHORT).show()
} else {
val okraResult = it.data!!.getStringExtra(OkraMainActivity.OKRA_RESULT)
Toast.makeText(this, okraResult, Toast.LENGTH_SHORT).show()
}
}
val okraOptions = OkraOptions.OptionsBuilder("INSERT KEY HERE","INSERT TOKEN","INSERT ENV HERE","INSERT NAME HERE", "INSERT PRODUCTS HERE")
//Add additional properties here.
.appId("")
.color("")
.connectMessage("")
.currency("")
.isCorporate(true)
.build()
val intent = OkraMainActivity.newIntent(this, okraOptions)
activityResultLauncher.launch(intent)
| Name | Type | Required | Default Value | Description |
|---|---|---|---|---|
app_id |
String |
true | Your app id from your Okra Dashboard. | |
okraKey |
String |
true | Your public key from your Okra Dashboard. | |
token |
String |
true | Your token from your Okra Dashboard. | |
env |
String |
false | production |
production(live)/production-sandbox (test) |
products |
Array |
true | ['Auth'] |
The Okra products you want to use with the widget. |
payment |
Booelan |
false | Whether you want to initiate a payment (https://docs.okra.ng/docs/payments) | |
charge |
Object |
false | Payment charge opject (https://docs.okra.ng/docs/creating-a-charge) | |
products |
Array |
true | ['Auth'] |
The Okra products you want to use with the widget. |
logo |
String(URL) |
false | Okra's Logo | |
name |
String |
false | Your Company's name | Name on the widget |
color |
HEX |
false | #3AB795 | Theme on the widget |
limit |
Number |
false | 24 | Statement length |
filter |
Object |
false | Filter for widget | |
isCorporate |
Boolen |
false | false |
Corporate or Individual account |
connectMessage |
String |
false | Instruction to connnect account | |
widget_success |
String |
false | Widget Success Message | |
widget_failed |
String |
false | Widget Failed Message | |
callback_url |
String(Url) |
false | ||
currency |
String |
false | NGN | Wallet to bill |
exp |
Date |
false | Won't expire | Expirary date of widget |
options |
Object |
false | You can pass a object custom values eg id | |
onSuccess |
Function |
false | Action to perform after widget is successful | |
onClose |
Function |
false | Action to perform if widget is closed | |
onError |
Function |
false | Action to perform on widget Error | |
BeforeClose |
Function |
false | Action to perform before widget close | |
onEvent |
Function |
false | Action to perform on widget event |
View a complete list of customizable options here
| Name | Type | Required | Description |
|---|---|---|---|
short_url |
String |
true | Your generated url from our App builder. |
onSuccess |
Function |
false | Action to perform after widget is successful |
onClose |
Function |
false | Action to perform if widget is closed |
onError |
Function |
false | Action to perform on widget Error |
BeforeClose |
Function |
false | Action to perform before widget close |
onEvent |
Function |
false |
Checkout our API Overiview and see how to use the data you've received and other products you can use to create more personalized experiences for your customers!
Get started without writing a single line of code, Try our App Builder! Click here to get started
- (okraHQ/okra-react-native docs)[https://github.com/okraHQ/okra-react-native/blob/master/README.md]
Want to help make this package even more awesome? feel free to send in your PR to dev branch and we'd review it and ensure it gets added to the next release 😊
This project is licensed under MIT license.