Okra allows you to retrieve current and historical balance information from your customer. Use OkraJS to instantly authenticate your customer's account and automatically fetch their available and ledger balances. Being able to view their historical balance information gives you a true understanding of your customer’s average bank balance. Verifying an account balance is key to reducing the risk of returned payments and preventing transaction failures.
With our Balance product, you can notify your customer of low funds, so they can choose an alternate payment method and move forward seamlessly.
Whether you need to validate a user’s spending power or ability to pay, we provide access to the necessary balance information needed for your business to make informed decisions.
Real-time balance ensures that your user has the funds available to enjoy your services and reduces the possibility of NSF fees and overdrafts. Retrieving balances instantly means you can reduce the risk to your business while delivering a frictionless customer experience.
It only takes seconds to access real-time balances and get the insights you need.
You can choose a standard payment — where you will receive an NSF if the account balance is less than the payment amount, with the ability to check and charge later. You can also opt to garnish the payments. With this option, you can automatically adjust the payment to match the customer’s current available balance and collect the remaining payment amount once available.
In this guide, we'll walk through from scratch, how to use the Balance API in your project
If you're familiar with using Okra and already have Okra set up on your machine, you can skip to Identity API, otherwise, carefully follow the next section.
If you're new to Okra, you'll need to create an Okra developer account.
After creating your account, you'll need to login.
To find your API keys, navigate to the Settings menu on the Okra developer dashboard.
To better understand how Okra API keys work, check this tutorial
Before diving deep into the tutorial, you might need to get yourself familiar with the balance object models.
Unique Auth ID (Unique Okra Identifier)
Amount of Available Funds in the Account
The Closing Balance of the Account
Unique Account ID (Unique Okra Identifier)
Customer Connection Status (Did they Choose to Connect this Account to You?)
Unique Customer ID (Unique Okra Identifier)
See Manage Customers ]
Unique Record ID (Unique Okra Identifier)
Unique Company ID (Unique Okra Identifier) (Your Client Token)
Okra API Env the Auth was Pulled from
Date of Authentication
Last Date of Authentication
Updated 18 days ago