Skip to main content

​
Base URL

All API requests use the following base URLs: Use the sandbox URL while building and testing your integration. Switch to production only when you are ready to go live.

​
Request format

  • All request bodies must be JSON.
  • Set Content-Type: application/json on every request that includes a body.
  • File upload endpoints (such as business registration) accept multipart/form-data — see those endpoint pages for details.

​
Authentication

Every business endpoint requires three headers:
See Authentication for how to obtain each credential, key formats, rate limits, and scopes.

​
Response envelope

Success responses follow this envelope:
​
boolean
required
true if the request succeeded; false if it failed. Use this field for programmatic checks.
​
string
required
A human-readable outcome description. Use for logging — do not drive application logic from this string.
​
object | array
required
The response payload. A single object for actions and detail endpoints; an array for list endpoints.
Error responses use a different shape — status: false, no data field at all, and an error object with a machine-readable code. See Errors for the full envelope and error code reference.

​
List responses and pagination

Endpoints that return collections include a pagination object alongside data. The exact fields in pagination vary by endpoint — see Pagination for the two shapes in use and each endpoint’s own reference page for which one it returns.

​
Errors

On failure, status is false and message describes the problem — see Errors for the full envelope, error code table, and handling guidance.

​
Postman collection

A pre-configured Postman workspace with all endpoints is available at the link below — useful for exploring the API before writing integration code.

Interstellas Postman Collection

Test every endpoint interactively with pre-configured environments for sandbox and production.