Jump to Content

API Reference API Docs Log In

Wordpress

Reference for integrating with Okra Wordpress plugin

Installation

Click on code and download repo (zip).
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.
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

Click on the Add New Button on top of the table
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

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

Updated 5 months ago

What's Next

Checkout our SDK on Android, IOS, Flutter, React Native

Did this page help you?