Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xoxoday Balance API

Account balance retrieval

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

Tagged areas include Balance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 1 operation across 1 path, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://accounts.xoxoday.com/chef, https://stagingstores.xoxoday.com/chef.

1 operations 1 paths 13 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://accounts.xoxoday.com/chef
Authentication
OAuth 2.0, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Xoxoday Balance API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

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

Balance 1

Account balance retrieval

POST
/v1/oauth/api
Plum Pro API dispatcher
plumApiDispatch body → 200400404422502

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Voucher (19 properties), ApiError (5 properties), CancelPointsResult (3 properties), PlumRequest (3 properties). Each schema is shown below with its type and property counts.

GetFiltersResult
object
2 properties
GetVouchersResult
object
2 properties
PlaceOrderResult
object
2 properties
FetchPointsResult
object
3 properties
PlumRequest
object
3 properties 3 required
CancelPointsResult
object
3 properties
SendPointsResult
object
3 properties
GetOrderDetailsResult
object
2 properties
PlumResponse
object
Generic response wrapper. The nested payload depends on the operation invoked via the query field.
1 property
ApiError
object
5 properties
GetBalanceResult
object
2 properties
PaymentHistoryResult
object
2 properties
Voucher
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xoxoday-balance-api-openapi.yml Raw ↑

Other APIs Xoxoday publishes across the network.

Xoxoday Reward Links API
Xoxoday Reward Points API
Xoxoday Storefront Integration API
Xoxoday Authentication API
Xoxoday Gift Cards API
Xoxoday Orders API
Xoxoday Payments API
Xoxoday Reward Links API
Xoxoday Reward Points API