How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Beeketing Balance API

The Balance API from Beeketing — 2 operation(s) for balance.

Beeketing Balance API is one of 27 APIs that Beeketing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://shop-name.onshopbase.com.

2 operations 2 paths 6 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{shop}.onshopbase.com/admin
Authentication
API Key, API Key, API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Beeketing Balance API declares 3 security schemes for authenticating requests. An API key is passed in the header as APP_ACCESS_TOKEN (APP_ACCESS_TOKEN). An API key is passed in the header as SHOP_ACCESS_TOKEN (SHOP_ACCESS_TOKEN). An API key is passed in the header as USER_ACCESS_TOKEN (USER_ACCESS_TOKEN).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Balance 2
POST
/admin/balance/charge.json
Capture charge balance.
charge-invoice body → 200400
POST
/admin/balance/refund.json
Refund balance.
refund-balance body → 200400

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are RefundParamsDto (4 properties), swagggerCaptureChargeParams (4 properties), FailureResponse (2 properties), swagggerCaptureFailureResponse (2 properties). Each schema is shown below with its type and property counts.

SuccessResponse
object
1 property
swagggerCaptureFailureResponse
object
2 properties
FailureResponse
object
2 properties
swagggerCaptureChargeParams
object
4 properties
RefundParamsDto
object
4 properties
swagggerCaptureSuccessResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beeketing-balance-api-openapi.yml Raw ↑

Other APIs Beeketing publishes across the network.

Beeketing Abandoned Checkout API
Beeketing Collect API
Beeketing Custom Collection API
Beeketing Customer Address API
Beeketing Customer API
Beeketing Discount Code API
Beeketing Domain API
Beeketing Draft Order API
Beeketing Fulfillment API
Beeketing Fulfillment Service API
Beeketing Metafield API
Beeketing Order API
Where this information came from

This is an independent, third-party profile of Beeketing Balance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.