Create business

Endpoint

POST /clients/business

Headers

string

required

Your public API key.

string

required

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

Request body

string

required

The legal name of the business.

string

required

The ID of the country where the business is registered.

boolean

required

Set to true if this is a newly registered business, false if it is an existing one.

Response

boolean

true on success.

string

Human-readable outcome.

string

The unique ID of the newly created business. Save this — you will use it as your businessId header on subsequent requests.

string

The name of the business as registered.

Code examples

curl -X POST https://sandbox.stellasbank.com/api/v1/clients/business \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "Content-Type: application/json" \
  -d '{
    "businessName": "Acme Ltd",
    "countryId": "NG",
    "isNewBusiness": true
  }'

const res = await fetch("https://sandbox.stellasbank.com/api/v1/clients/business", {
  method: "POST",
  headers: {
    "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
    "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    businessName: "Acme Ltd",
    countryId: "NG",
    isNewBusiness: true,
  }),
});
const { data } = await res.json();
const businessId = data.business.id;

import requests

res = requests.post(
    "https://sandbox.stellasbank.com/api/v1/clients/business",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
    },
    json={"businessName": "Acme Ltd", "countryId": "NG", "isNewBusiness": True},
)
business_id = res.json()["data"]["business"]["id"]

Example response

{
  "status": true,
  "message": "Business created successfully",
  "data": {
    "business": {
      "id": "biz_xyz789",
      "businessName": "Acme Ltd"
    }
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Request body

Response

Code examples

Example response

​Endpoint

​Headers

​Request body

​Response

​Code examples

​Example response

Endpoint

Headers

Request body

Response

Code examples

Example response