Skip to main content
The Interstellas API uses session-based bearer token authentication. Before calling any business endpoint, sign in to exchange your credentials for an access token.

Prerequisites

  • An Interstellas account — sign up at interstellas.com
  • Your account email and password
  • Your SECRET_KEY from Settings → API Keys in the dashboard

Step 1 — Sign in and get an access token

curl -X POST https://sandbox.stellasbank.com/api/v1/auth/signin \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "YOUR_PASSWORD"
  }'
A successful response returns your accessToken and the list of businesses registered to your account:
{
  "status": true,
  "message": "Login successful",
  "data": {
    "id": "usr_abc123",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "email": "you@example.com",
    "phoneNo": "+2348012345678",
    "accessToken": "eyJhbGciOiJIUzI1NiIs...",
    "businesses": [
      { "id": "biz_xyz789", "businessName": "Acme Ltd", "isApproved": true }
    ]
  }
}
Save the accessToken and note the id from the businesses array — that is your businessId.

Step 2 — Make an authenticated request

Every business endpoint requires three headers: your access token, your secret key, and your business ID.
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"

Next steps

Authentication

Understand the full three-header auth scheme and how to manage credentials.

API Reference

Browse every available endpoint.

Errors

Learn how errors are structured and how to handle them.

Pagination

Work with list endpoints that return paginated results.