Overview

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.

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
}

Endpoints#

• POST/api/checkout-api/sessionsCreate session
• GET/api/checkout-api/sessionsList sessions
• GET/api/checkout-api/sessions/{session_id}Retrieve session
• POST/api/checkout-api/sessions/{session_id}/cancelCancel session
• GET/api/withdrawal-api/walletsList wallets
• POST/api/withdrawal-api/withdrawalsCreate withdrawal
• GET/api/withdrawal-api/withdrawalsList withdrawals
• GET/api/withdrawal-api/withdrawals/{withdrawal_id}Retrieve withdrawal
• GET/api/customer-balance-api/customersList customers
• POST/api/customer-balance-api/customers/infoRetrieve customer
• POST/api/customer-balance-api/customers/add-balanceAdd balance
• POST/api/customer-balance-api/customers/deduct-balanceDeduct balance
• POST/api/customer-balance-api/customers/transactionsList transactions