Sandbox

Download Spec

API endpoints to manage test customers in the Sandbox environment.

post/sandbox/customers/create

Create Sandbox Customers

This operation enables you to create sandbox customers and manually define their details.

Array of object (create sandbox customers)s

noOfAccountint

Sets the number of bank accounts the user has.

Max: 5

namestring

Sets the name of the customer.

bankstring

The unique ID of the bank where the customer has an account. Visit Okra's Coverage page for the list of bank IDs.

usernamestring

Sets the test username for the customer. Use this test credential when testing the account connection flow.

passwordstring

Sets the test password for the customer. Use this test credential when testing the account connection flow.

typestring

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

volumestring

Determines the amount of transaction statements available for this customer.

Enum: low
medium
high

identityint

Determines how complete the customer's identity details are.

Min: 1
Max: 100

internetSpeedint

Determines the customer's internet speed.

Min: 2
Max: 4

Responses

Request examples

[
  {
    "noOfAccount": 1,
    "name": "Austin Matthews",
    "bank": "5d6fe57a4099cc4b210bbeb3",
    "username": "test_username",
    "password": "test_password",
    "type": "ind",
    "volume": "high",
    "identity": 60,
    "internetSpeed": 4
  }
]

Response examples

The details of the customer that you created.

Empty response

post/sandbox/customers/list

List Sandbox Customers

This operation lists all sandbox customers in your project. You do not need to add any parameters to your request.

HTTP bearerbearer

This operation lists all sandbox customers in your project. You do not need to add any parameters to your request.

Responses

Response examples

Empty response

post/sandbox/customers/get

Get Sandbox Customer

This operation enables you to a sandbox customer using their customer ID.

customerstring

required

The unique ID of a customer.

Example: "140afb3ddecee700130acbc4"

Responses

Request examples

{
  "customer": "140afb3ddecee700130acbc4"
}

Response examples

Empty response

post/sandbox/customers/generate

Autogenerate Sandbox Customers

This operation enables you to auto-generate sandbox customers.

createboolean

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.

numberint

Define the number of customers you want to create.

Max: 10

Responses

Request examples

{
  "create": true,
  "number": 5
}

Response examples

Empty response