List customers

Endpoint

GET /clients/business/customers

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

The ID of the business whose customers you want to list.

Query parameters

integer

Page number. Defaults to 1.

integer

Records per page. Defaults to 10.

See Pagination for full usage.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of customer objects.

string

Unique customer ID.

string

Full name of the customer.

string

Customer’s phone number.

string

Customer’s email address.

string

ISO 8601 timestamp of when the customer record was created.

string

The NUBAN account number assigned to this customer.

integer

The current page number.

integer

The page size used for this response.

integer

Total number of records matching the current query, across all pages.

integer

The final page number, derived from total ÷ limit. See Pagination — this endpoint uses Shape B.

Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business/customers?page=1&limit=10" \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business/customers?page=1&limit=10",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/customers",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 10},
)
print(res.json())

Example response

{
  "status": true,
  "message": "Customers retrieved successfully",
  "data": [
    {
      "id": "cust_001",
      "name": "Grace Hopper",
      "phoneNo": "+2348098765432",
      "email": "grace@example.com",
      "dateCreated": "2024-03-15T10:30:00.000Z",
      "nuban": "9876543210"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 50,
    "totalPages": 5
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Query parameters

Response

Code examples

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Code examples

​Example response

Endpoint

Headers

Query parameters

Response

Code examples

Example response