Sandbox
API endpoints to manage test customers in the Sandbox environment.
Create Sandbox Customers
This operation enables you to create sandbox customers and manually define their details.
/sandbox/customers/create array[object (Create Sandbox Customers)] An array of customer objects.
Create Sandbox Customers object (Create Sandbox Customers) noOfAccount int Sets the number of bank accounts the user has.
- Max
- 5
name string Sets the name of the customer.
bank string The unique ID of the bank where the customer has an account. Visit Okra's Coverage page for the list of bank IDs.
username string Sets the test username for the customer. Use this test credential when testing the account connection flow.
password string Sets the test password for the customer. Use this test credential when testing the account connection flow.
type string Sets the type of the customer's bank account. 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. ind referst to individual or personal accounts. corp refers to corporate or business accounts.
- Enum
-
- ind
- corp
volume string Determines the amount of transaction statements available for this customer.
- Enum
-
- low
- medium
- high
identity int Determines how complete the customer's identity details are.
- Min
- 1
- Max
- 100
internetSpeed int Determines the customer's internet speed.
- Min
- 2
- Max
- 4
bearer
Requests
[
{
"noOfAccount": 1,
"name": "Austin Matthews",
"bank": "5d6fe57a4099cc4b210bbeb3",
"username": "test_username",
"password": "test_password",
"type": "ind",
"volume": "high",
"identity": 60,
"internetSpeed": 4
}
]Responses
The details of the customer that you created.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List Sandbox Customers
This operation lists all sandbox customers in your project. You do not need to add any parameters to your request.
/sandbox/customers/list bearer
Responses
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get Sandbox Customer
This operation enables you to a sandbox customer using their customer ID.
/sandbox/customers/get customer string required
The unique ID of a customer.
- Example
- "140afb3ddecee700130acbc4"
bearer
Requests
{
"customer": "140afb3ddecee700130acbc4"
}Responses
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Autogenerate Sandbox Customers
This operation enables you to auto-generate sandbox customers.
/sandbox/customers/generate create boolean This option enables you to preview customers before creating them. true creates the number of customers you define. false returns customer details in a preview response. To create the customers based on the review, you can pass the data object from the response to Create Sandbox Customers endpoint operation.
number int Define the number of customers you want to create.
- Max
- 10
bearer
Requests
{
"create": true,
"number": 5
}Responses
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?