Skip to main content

​
Overview

The Interstellas API gives you programmatic access to the full suite of features available on the Interstellas dashboard. Built on REST principles, it lets you integrate financial operations, account management, and transaction processing directly into your own application. All endpoints are organised around the core resources you interact with on the dashboard. The API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes to communicate the outcome of each request.
All API requests must be made over HTTPS. Requests made over plain HTTP will be rejected.
Base URL

Quick Start

Make your first API call in minutes.

Authentication

Manage and rotate your API keys securely.

API Reference

Explore all available endpoints and parameters.

Postman Collection

Test the API interactively with a pre-configured workspace.

​
Authentication

The Interstellas API authenticates every request with an API key and secret. Generate a credential pair from the dashboard — you’ll receive a test secret (stl_test_...) for sandbox and a live secret (stl_live_...) for production. Always use test credentials while building and validating your integration. Pass both on every request:
Your API key and secret carry significant privileges. Never expose them in client-side code, public repositories, or application logs. Requests made without valid credentials return 401 Unauthorized.

​
Making Requests

The API supports the standard HTTP methods — GET, POST, PUT, and DELETE. All request bodies must be JSON-encoded and include the Content-Type: application/json header. Each endpoint in this reference includes a sample HTTP request. Insert your credentials and specific parameters to run the call directly.
Download the Interstellas Postman Collection to get a pre-configured workspace with all available endpoints ready to test.

​
Response Format

All responses are JSON-encoded. The Content-Type response header will always be application/json. Every response follows a consistent envelope structure:
​
boolean
required
true if the request was processed without errors; false otherwise. Use this field for programmatic checks in your integration logic.
​
string
required
A human-readable description of the outcome. Provides additional context on success and an explanation when status is false.
Log this value for debugging — do not use it for conditional logic in your application.
​
object
The actionable payload returned by the endpoint. Structure varies per endpoint and is present only when the operation produces a result.

​
Pagination

Endpoints that return collections of resources support page-based pagination. Use the page and limit query parameters to control which subset of records is returned. When pagination applies, the response includes a top-level pagination object alongside data:
The exact fields inside pagination differ by endpoint — there are two shapes in use across the API. See Pagination for both shapes, and each endpoint’s own reference page for which one it returns.