Understand how the Stax Bill API is structured, what request and response formats it uses, and where to find examples, authentication details, and tutorials.
Use this page to understand how the Stax Bill API behaves, what each request must include, and where to find examples before you send your first call.
At a glance
API style
- The Stax Bill API is organized around REST.
- The API uses predictable, resource-oriented URLs.
- The API uses HTTP response codes to indicate success and errors.
- The API uses standard HTTP features, including authentication and HTTP verbs, so it works with off-the-shelf HTTP clients.
Request and response format
- Set header content to application/JSON.
- The API returns JSON for all responses, including errors.
- Some calls support cross-origin resource sharing (CORS), which lets you interact with the API from a client-side web application.
- Never expose your secret API key in public client-side code.
Request a sandbox account from your implementation specialist before you start testing. A member of your team may already have access from the initial implementation process.
Send requests and learn workflows
Send requests
- Each method includes a sample cURL request.
- Replace the example parameters with your own values to test calls from the command line.
- If you prefer a GUI client, use POSTMAN to send requests and inspect responses.
Learn common workflows
- C# and Python usage examples are available where relevant.
- Sample JSON payloads are included for supported operations.
- Follow the sample workflows and tutorials for common use cases and implementation best practices.
How Stax Bill uses the API
The Stax Bill development team builds account-facing and customer-facing applications on top of the Stax Bill API. This helps validate that the interface supports real integration needs and performs well under production use.
New features are first launched against a private API resource so the team can evaluate interface and performance stability before wider release. After those resources are proven stable, they may become available through the Stax Bill API.