Environments
The production base URL is https://prod-app.octanetech-api.com/api/v1/integration. Staging keys start with oct_test_ and only work on staging.
There is one production base URL, https://prod-app.octanetech-api.com/api/v1/integration. The staging host and a test key are provided by your Octane account manager during onboarding. A key works only in the environment it was issued for.
Base URLs
| Environment | Base URL | Key prefix |
|---|---|---|
| Production | https://prod-app.octanetech-api.com/api/v1/integration | oct_live_ |
| Staging | Provided by Octane during onboarding | oct_test_ |
All Pull API paths in this documentation are relative to the base URL. For example, the transactions endpoint is:
GET https://prod-app.octanetech-api.com/api/v1/integration/transactionsDifferences between environments
| Production | Staging | |
|---|---|---|
| IP allow-list | Required for every key | Not required; test keys accept any source IP |
| Rate limit | 60 requests per minute per key | 60 requests per minute per key |
| Data | Your live transactions | Test data |
| Webhooks | Delivered to your production URL | Delivered to the URL configured on the test key |
Staging keys are only issued on staging and are rejected on production. Ask your Octane account manager for a staging key if you want to build against test data before going live.
API version
Webhook payloads carry an api_version field (currently 2026-09-01). The Pull API response shape and the webhook data.transaction object are the same version. Backwards-incompatible changes to either will be announced in the Changelog before they ship.
New fields may be added to responses and payloads at any time without a version change. Build your parser to ignore unknown fields.
Transport
- HTTPS only. Plain HTTP is not served.
- Responses are UTF-8 JSON with
Content-Type: application/json. - All timestamps are ISO 8601 in UTC (suffix
Z).