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

Howler Topupables API

The Topupables API from Howler — 1 operation(s) for topupables.

Howler Topupables API is one of 17 APIs that Howler publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Topupables. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

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

Requests are made against a single base URL, https://{defaultHost}/api/v3/consumer_portal.

1 operations 1 paths 15 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.6.1
Base URL
https://www.howler.co.za/api/v3/consumer_portal
Authentication
OAuth 2.0, HTTP Bearer, API Key, HTTP Bearer, API Key, HTTP Basic, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 8

Howler Topupables API declares 8 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes. It accepts HTTP bearer tokens (oauth2) (bearer_header). An API key is passed in the query as bearer_token (bearer_param). It accepts HTTP bearer tokens (JWT) (jwt_header). An API key is passed in the query as bearer_token (jwt_param). It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as x-auth-token (api_key). It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

  • oauth2 — OAuth2 authentication for third-party applications
  • jwt_header — JWT token obtained from basic authentication login
  • jwt_param — JWT token as query parameter (alternative to Authorization header)
  • basic_auth — Basic authentication with email and password
  • api_key — API key authentication
  • bearer_auth — JWT token authentication

Paths & Operations 1

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

Topupables 1
GET
/topupables
list topupables
getConsumerTopupables 1 param → 200400

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Event (27 properties), Ticket (26 properties), TicketType (16 properties), UserValidationConfiguration (13 properties). Each schema is shown below with its type and property counts.

CashlessTagBalance
object
6 properties 5 required
Answer
object
3 properties 3 required
UserValidationConfiguration
object
Indicates which user details need to be completed before their profile is considered setup for an event.
13 properties 13 required
Event
object
27 properties 12 required
TicketType
object
16 properties 4 required
Question
object
6 properties 4 required
TopupsConfiguration
object
5 properties 4 required
Venue
object
7 properties 7 required
CashlessTagPairing
object
8 properties 7 required
Topupable
object
2 properties
Ticket
object
26 properties 16 required
TicketCategory
object
6 properties 5 required
User
object
5 properties 5 required
CustomerSettingsConfiguration
object
6 properties
Addonable
objectnull
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

howler-topupables-api-openapi.yml Raw ↑

Other APIs Howler publishes across the network.

Howler Artists API
Howler Assign Ticket API
Howler Bank Account API
Howler Basic Authentication API
Howler Cashless Tags API
Howler Cashout API
Howler Email OTP API
Howler Events API
Howler OAuth API
Howler Third Party OAuth API
Howler Tickets API
Howler Top Up API