Sandbox

Okra recommends that you use the sandbox environment when building and testing your integration. This environment offers realistic data that follows standard use cases. You can test all API endpoints, generate test users, test the widget, and even implement webhooks through this environment.

Use sandbox

When using the API

Set your base URL to https://api.okra.ng/v2/sandbox/. Check out Okra's API environments for more details.

When creating your Widget experience

Set the value of env to production-sandbox when you build with options. Visit the Integration guide for more details

In the Dashboard

Select Test mode in the top right.

Create test customers

To test how your customer will go through the account connection flow, you need to create a test customer. You can do this in multiple ways:

You can create a customer via the Dashboard. You have the option to manually fill out customer details and define the login credentials, which are needed to go through the account connection flow. You also have the option to autogenerate a customer.
You can create a customer via the API. You can define customer details manually in your request using the Create customer endpoint operation. You can also auto-generate customers using the Autogenerate endpoint operation.

📘
When creating customers, the account type you select determines the data set that the API generates. For example, the API only generates BVN and NUBAN values for customers with Personal accounts.

Fetch test customers

After you generate test customers, the Okra API immediately creates the user information. You can check out the resulting customer data in two ways:

Visit the Customers page on the Dashboard to find the customer you created.
You can also retireve data directly from the API. Visit the API reference to see how you can get a specific sandbox customer, or list all sandbox customers in your project.

Connect a bank account

Visit the Quickstart guide to set up a demo Widget implementation in 5 easy steps.

When you test your implementation, use these test credentials to connect the sandbox customer that you created:

Test credentials

Fields	Value	Notes
User name	The sandbox customer's user name that you define when you create a test customer.
Password	The sandbox customer's password that you define when you create a test customer.
Payment OTP	`11111`
Login OTP	`11111`
Transaction Pin	`11111`
Secret Answer	`11111`	Secret Answer is required by these banks in their authentication flow: - `fidelity-bank` - `united-bank-for-africa` - `first-bank-of-nigeria` - `rubies-bank` - `unity-bank` - `suntrust-bank`
BVN	The API generates test BVNs for customers with Personal accounts.	You can check the test BVNs for each customer you generated via the Dashboard. BVN is required by these banks in their authentication flow: - `fidelity-bank` - `united-bank-for-africa` - `first-bank-of-nigeria` - `rubies-bank`

Need help?

Check out the Widget Errors and the API Errors guide to understand the different error scenarios.
Join Okra's Developer Community on Slack if you have technical questions or need help with your code.
Get in touch with the Support team if you have any questions about Okra's products.