Overview

Base URL, authentication, request format and pagination for the OpenStock API.

The OpenStock API is a JSON-over-HTTPS REST API. Requests and responses use application/json, timestamps are ISO 8601 strings in UTC, and amounts are plain numbers in the store’s currency.

Checkout sessionsCreate, retrieve, list, and cancel hosted checkouts.WithdrawalsInspect wallets and create or track crypto payouts.Customer balanceFind customers and manage store-scoped balances.

OpenAPI specification#

Download the OpenAPI 3.1 specification to import the supported endpoints into your API client. It includes request parameters, permission requirements, and response examples from this reference.

Public API and dashboard endpoints

The public API currently covers the three groups below. An authenticated dashboard request is not automatically available to a store API key. Use the documented endpoints and permissions rather than copying an internal request from your browser.

Base URL#

https://openstock.dev

Authentication#

Send a store API key as a bearer token on every request. See Authentication for permissions and key management.

Authorization: Bearer sk_your_secret_key

Pagination#

List endpoints accept limit (1–100, default 20) and offset (default 0) and return the total alongside the page:

{
  "data": [
    "…"
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

A reliable integration#

Keep your store API key in a server environment variable.
Start with a read-only request using the least permission you need.
Inspect the HTTP status before parsing a response as successful.
Record resource IDs and your own order reference when creating a session or payout.
Verify payment using session status or a signed webhook before delivering custom goods.
Check the recorded outcome before retrying a timed-out balance change or withdrawal.

Endpoints#