Skip to main content

Endpoint

GET /clients/business/account-details

Headers

Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
SECRET_KEY
string
required
Your API secret key.
businessId
string
required
The ID of the business whose account details you want to retrieve.

Response

status
boolean
true on success.
message
string
Human-readable outcome.
data.accountNumber
string
The NUBAN account number assigned to this business.
data.accountType
string
The type of account, e.g. "savings" or "current".
data.customerId
string
The customer ID in the banking system.
data.businessId
string
The business ID associated with this account.
data.accountBalance
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 "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

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.