Sandbox

Download Spec

API endpoints to manage test customers in the Sandbox environment.

Create Sandbox Customers
post /sandbox/customers/create

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

array[object (Create Sandbox Customers)]

An array of customer objects.

Request

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

Response

ExamplesSchema

The details of the customer that you created.

Empty response

List Sandbox Customers
post /sandbox/customers/list

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

HTTP bearer bearer

Response

ExamplesSchema

Empty response

Get Sandbox Customer
post /sandbox/customers/get

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

customer

string

required

The unique ID of a customer.

Example
"140afb3ddecee700130acbc4"

Request

{
  "customer": "140afb3ddecee700130acbc4"
}

Response

ExamplesSchema

Empty response

Autogenerate Sandbox Customers
post /sandbox/customers/generate

This operation enables you to auto-generate sandbox customers.

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

Request

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

Response

ExamplesSchema

Empty response

Was this page helpful?