Get account details

Response

boolean

true on success.

string

Human-readable outcome.

string

The NUBAN account number assigned to this business.

string

The type of account, e.g. "savings" or "current".

string

The customer ID in the banking system.

string

The business ID associated with this account.

string

The current account balance, denominated in kobo (smallest currency unit).

Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/business/account-details \
  -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/account-details",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/account-details",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
)
print(res.json()["data"])

Example response

{
  "status": true,
  "message": "Account details retrieved successfully",
  "data": {
    "accountNumber": "0123456789",
    "accountType": "current",
    "customerId": "cust_abc123",
    "businessId": "biz_xyz789",
    "accountBalance": "5000000"
  }
}

accountBalance is expressed in kobo. Divide by 100 to convert to naira. For example, "5000000" is ₦50,000.

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Response

Code examples

Example response

​Endpoint

​Headers

​Response

​Code examples

​Example response

Endpoint

Headers

Response

Code examples

Example response